Adjust object index typings (#5671)

* Adjust object index typings

* CHANGELOG

* Remove dot-notation overrides

* Align overrides

* Ordering

* Revert lint formatting changes

* Bump common

Author: jacogr

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## master
+
+Changes:
+
+- Adjust object index access for stricter tsconfig settings
+
+
 ## 10.8.1 Jun 5, 2023
 
 Contributed:

eslint.config.js

@@ -4,6 +4,13 @@
 import baseConfig from '@polkadot/dev/config/eslint';
 
 export default [
+  {
+    ignores: [
+      // see the tsconfig.eslint.json for explanation
+      'packages/api-augment/src/kusama/*.ts',
+      'packages/api-augment/src/polkadot/*.ts'
+    ]
+  },
   ...baseConfig,
   {
     rules: {

package.json

@@ -40,7 +40,7 @@
     "test:one": "polkadot-dev-run-test --env node"
   },
   "devDependencies": {
-    "@polkadot/dev": "^0.75.16",
+    "@polkadot/dev": "^0.75.19",
     "@polkadot/typegen": "workspace:packages/typegen",
     "@types/node": "^20.2.5"
   },

packages/api-augment/package.json

@@ -26,7 +26,7 @@
     "@polkadot/types": "10.8.1",
     "@polkadot/types-augment": "10.8.1",
     "@polkadot/types-codec": "10.8.1",
-    "@polkadot/util": "^12.2.2",
+    "@polkadot/util": "^12.3.1",
     "tslib": "^2.5.3"
   }
 }

packages/api-base/package.json

@@ -23,7 +23,7 @@
   "dependencies": {
     "@polkadot/rpc-core": "10.8.1",
     "@polkadot/types": "10.8.1",
-    "@polkadot/util": "^12.2.2",
+    "@polkadot/util": "^12.3.1",
     "rxjs": "^7.8.1",
     "tslib": "^2.5.3"
   }

packages/api-contract/package.json

@@ -22,16 +22,17 @@
   "main": "index.js",
   "dependencies": {
     "@polkadot/api": "10.8.1",
+    "@polkadot/api-augment": "10.8.1",
     "@polkadot/types": "10.8.1",
     "@polkadot/types-codec": "10.8.1",
     "@polkadot/types-create": "10.8.1",
-    "@polkadot/util": "^12.2.2",
-    "@polkadot/util-crypto": "^12.2.2",
+    "@polkadot/util": "^12.3.1",
+    "@polkadot/util-crypto": "^12.3.1",
     "rxjs": "^7.8.1",
     "tslib": "^2.5.3"
   },
   "devDependencies": {
     "@polkadot/api-augment": "10.8.1",
-    "@polkadot/keyring": "^12.2.2"
+    "@polkadot/keyring": "^12.3.1"
   }
 }

packages/api-contract/src/Abi/Abi.spec.ts

@@ -101,7 +101,7 @@ describe('Abi', (): void => {
             JSON.parse(fs.readFileSync(cmpFile, 'utf-8'))
           );
         } catch (error) {
-          if (process.env.GITHUB_REPOSITORY) {
+          if (process.env['GITHUB_REPOSITORY']) {
             console.error(registryJson);
 
             throw error;
@@ -114,8 +114,8 @@ describe('Abi', (): void => {
   });
 
   it('has the correct hash for the source', (): void => {
-    const abi = new Abi(abis.ink_v0_flipperBundle);
-    const bundle = abis.ink_v0_flipperBundle as unknown as JSONAbi;
+    const abi = new Abi(abis['ink_v0_flipperBundle']);
+    const bundle = abis['ink_v0_flipperBundle'] as unknown as JSONAbi;
 
     // manual
     expect(bundle.source.hash).toEqual(blake2AsHex(bundle.source.wasm));

packages/api-contract/src/Abi/index.ts

@@ -12,6 +12,12 @@ import { assertReturn, compactAddLength, compactStripLength, isBn, isNumber, isO
 
 import { convertVersions, enumVersions } from './toLatest.js';
 
+interface AbiJson {
+  version?: string;
+
+  [key: string]: unknown;
+}
+
 const l = logger('Abi');
 
 const PRIMITIVE_ALWAYS = ['AccountId', 'AccountIndex', 'Address', 'Balance'];
@@ -26,12 +32,12 @@ function findMessage <T extends AbiMessage> (list: T[], messageOrId: T | string
   return assertReturn(message, () => `Attempted to call an invalid contract interface, ${stringify(messageOrId)}`);
 }
 
-function getLatestMeta (registry: Registry, json: Record<string, unknown>): ContractMetadataLatest {
+function getLatestMeta (registry: Registry, json: AbiJson): ContractMetadataLatest {
   // this is for V1, V2, V3
   const vx = enumVersions.find((v) => isObject(json[v]));
 
   // this was added in V4
-  const jsonVersion = json.version as string;
+  const jsonVersion = json.version;
 
   if (!vx && jsonVersion && !enumVersions.find((v) => v === `V${jsonVersion}`)) {
     throw new Error(`Unable to handle version ${jsonVersion}`);
@@ -56,7 +62,7 @@ function getLatestMeta (registry: Registry, json: Record<string, unknown>): Cont
 function parseJson (json: Record<string, unknown>, chainProperties?: ChainProperties): [Record<string, unknown>, Registry, ContractMetadataLatest, ContractProjectInfo] {
   const registry = new TypeRegistry();
   const info = registry.createType('ContractProjectInfo', json) as unknown as ContractProjectInfo;
-  const latest = getLatestMeta(registry, json);
+  const latest = getLatestMeta(registry, json as unknown as AbiJson);
   const lookup = registry.createType('PortableRegistry', { types: latest.types }, true);
 
   // attach the lookup to the registry - now the types are known

packages/api-contract/src/Abi/toLatest.spec.ts

@@ -10,7 +10,7 @@ import { v0ToLatest, v1ToLatest, v2ToLatest, v3ToLatest, v4ToLatest } from './to
 
 describe('v0ToLatest', (): void => {
   const registry = new TypeRegistry();
-  const contract = registry.createType('ContractMetadata', { V0: abis.ink_v0_erc20 });
+  const contract = registry.createType('ContractMetadata', { V0: abis['ink_v0_erc20'] });
   const latest = v0ToLatest(registry, contract.asV0);
 
   it('has the correct constructors', (): void => {
@@ -52,7 +52,7 @@ describe('v0ToLatest', (): void => {
 
 describe('v1ToLatest', (): void => {
   const registry = new TypeRegistry();
-  const contract = registry.createType('ContractMetadata', { V1: abis.ink_v1_flipper.V1 });
+  const contract = registry.createType('ContractMetadata', { V1: abis['ink_v1_flipper']['V1'] });
   const latest = v1ToLatest(registry, contract.asV1);
 
   it('has the correct constructors', (): void => {
@@ -68,7 +68,7 @@ describe('v1ToLatest', (): void => {
   });
 
   it('has the correct messages with namespaced method name', (): void => {
-    const contract = registry.createType('ContractMetadata', { V1: abis.ink_v1_psp22.V1 });
+    const contract = registry.createType('ContractMetadata', { V1: abis['ink_v1_psp22']['V1'] });
     const latest = v1ToLatest(registry, contract.asV1);
 
     expect(
@@ -87,7 +87,7 @@ describe('v1ToLatest', (): void => {
 
 describe('v2ToLatest', (): void => {
   const registry = new TypeRegistry();
-  const contract = registry.createType('ContractMetadata', { V2: abis.ink_v2_flipper.V2 });
+  const contract = registry.createType('ContractMetadata', { V2: abis['ink_v2_flipper']['V2'] });
   const latest = v2ToLatest(registry, contract.asV2);
 
   it('has the correct constructor flag', (): void => {
@@ -99,7 +99,7 @@ describe('v2ToLatest', (): void => {
 
 describe('v3ToLatest', (): void => {
   const registry = new TypeRegistry();
-  const contract = registry.createType('ContractMetadata', { V3: abis.ink_v3_flipper.V3 });
+  const contract = registry.createType('ContractMetadata', { V3: abis['ink_v3_flipper']['V3'] });
   const latest = v3ToLatest(registry, contract.asV3);
 
   it('has the correct constructor flags', (): void => {
@@ -112,7 +112,7 @@ describe('v3ToLatest', (): void => {
   });
 
   it('has the correct messages', (): void => {
-    const contract = registry.createType('ContractMetadata', { V3: abis.ink_v3_traitErc20.V3 });
+    const contract = registry.createType('ContractMetadata', { V3: abis['ink_v3_traitErc20']['V3'] });
     const latest = v3ToLatest(registry, contract.asV3);
 
     expect(
@@ -125,7 +125,7 @@ describe('v3ToLatest', (): void => {
 
 describe('v4ToLatest', (): void => {
   const registry = new TypeRegistry();
-  const contract = registry.createType('ContractMetadata', { V4: abis.ink_v4_flipperContract });
+  const contract = registry.createType('ContractMetadata', { V4: abis['ink_v4_flipperContract'] });
   const latest = v4ToLatest(registry, contract.asV4);
 
   it('has the correct constructor flags', (): void => {

packages/api-contract/src/augment.ts

@@ -0,0 +1,4 @@
+// Copyright 2017-2023 @polkadot/api-contract authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import '@polkadot/api-augment';