Support for ink! v4 metadata (#5195)

* Support for ink! v4 metadata

* Adjust

* Export v4ToLatest

* Adjust expectations

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

@@ -35,6 +35,9 @@ interface JSONAbi {
   },
   V3: {
     spec: SpecDef;
+  },
+  V4: {
+    spec: SpecDef;
   }
 }
 
@@ -59,7 +62,7 @@ describe('Abi', (): void => {
 
       it(`initializes from a contract ABI (${abiName})`, (): void => {
         try {
-          const messageIds = (abi.V3 || abi.V2 || abi.V1 || abi).spec.messages.map(({ label, name }) =>
+          const messageIds = (abi.V4 || abi.V3 || abi.V2 || abi.V1 || abi).spec.messages.map(({ label, name }) =>
             label || (
               Array.isArray(name)
                 ? name.join('::')

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

@@ -27,12 +27,23 @@ function findMessage <T extends AbiMessage> (list: T[], messageOrId: T | string
 }
 
 function getLatestMeta (registry: Registry, json: Record<string, unknown>): ContractMetadataLatest {
+  // this is for V1, V2, V3
   const vx = enumVersions.find((v) => isObject(json[v]));
-  const metadata = registry.createType('ContractMetadata',
+
+  // this was added in V4
+  const jsonVersion = json.version as string;
+
+  if (!vx && jsonVersion && !enumVersions.find((v) => v === `V${jsonVersion}`)) {
+    throw new Error(`Unable to handle version ${jsonVersion}`);
+  }
+
+  const metadata = registry.createType<ContractMetadata>('ContractMetadata',
     vx
       ? { [vx]: json[vx] }
-      : { V0: json }
-  ) as unknown as ContractMetadata;
+      : jsonVersion
+        ? { [`V${jsonVersion}`]: json }
+        : { V0: json }
+  );
   const converter = convertVersions.find(([v]) => metadata[`is${v}`]);
 
   if (!converter) {

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

@@ -1,10 +1,10 @@
 // Copyright 2017-2022 @polkadot/api-contract authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import { v0ToLatest, v1ToLatest, v2ToLatest, v3ToLatest } from '@polkadot/api-contract/Abi/toLatest';
 import { TypeRegistry } from '@polkadot/types';
 
 import abis from '../test/contracts';
+import { v0ToLatest, v1ToLatest, v2ToLatest, v3ToLatest, v4ToLatest } from './toLatest';
 
 describe('v0ToLatest', (): void => {
   const registry = new TypeRegistry();
@@ -120,3 +120,18 @@ describe('v3ToLatest', (): void => {
     ]);
   });
 });
+
+describe('v4ToLatest', (): void => {
+  const registry = new TypeRegistry();
+  const contract = registry.createType('ContractMetadata', { V4: abis.ink_v4_flipperContract });
+  const latest = v4ToLatest(registry, contract.asV4);
+
+  it('has the correct constructor flags', (): void => {
+    expect(
+      latest.spec.constructors[0].payable.isTrue
+    ).toEqual(false);
+    expect(
+      latest.spec.constructors[1].payable.isTrue
+    ).toEqual(false);
+  });
+});

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

@@ -1,16 +1,17 @@
 // Copyright 2017-2022 @polkadot/api-contract authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import type { ContractMetadataLatest, ContractMetadataV3 } from '@polkadot/types/interfaces';
+import type { ContractMetadataLatest, ContractMetadataV4 } from '@polkadot/types/interfaces';
 import type { Registry } from '@polkadot/types/types';
 
 import { v0ToV1 } from './toV1';
 import { v1ToV2 } from './toV2';
 import { v2ToV3 } from './toV3';
+import { v3ToV4 } from './toV4';
 
 // The versions where an enum is used, aka V0 is missing
 // (Order from newest, i.e. we expect more on newest vs oldest)
-export const enumVersions = <const> ['V3', 'V2', 'V1'];
+export const enumVersions = <const> ['V4', 'V3', 'V2', 'V1'];
 
 type Versions = typeof enumVersions[number] | 'V0';
 
@@ -22,15 +23,17 @@ function createConverter <I, O> (next: (registry: Registry, input: O) => Contrac
     next(registry, step(registry, input));
 }
 
-export function v3ToLatest (registry: Registry, v3: ContractMetadataV3): ContractMetadataLatest {
-  return v3;
+export function v4ToLatest (registry: Registry, v4: ContractMetadataV4): ContractMetadataLatest {
+  return v4;
 }
 
+export const v3ToLatest = createConverter(v4ToLatest, v3ToV4);
 export const v2ToLatest = createConverter(v3ToLatest, v2ToV3);
 export const v1ToLatest = createConverter(v2ToLatest, v1ToV2);
 export const v0ToLatest = createConverter(v1ToLatest, v0ToV1);
 
 export const convertVersions: [Versions, Converter][] = [
+  ['V4', v4ToLatest],
   ['V3', v3ToLatest],
   ['V2', v2ToLatest],
   ['V1', v1ToLatest],

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

@@ -0,0 +1,9 @@
+// Copyright 2017-2022 @polkadot/api-contract authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ContractMetadataV3, ContractMetadataV4 } from '@polkadot/types/interfaces';
+import type { Registry } from '@polkadot/types/types';
+
+export function v3ToV4 (registry: Registry, v3: ContractMetadataV3): ContractMetadataV4 {
+  return v3;
+}

packages/api-contract/src/test/compare/ink_v4_flipperContract.test.json

@@ -0,0 +1,9 @@
+[
+  {
+    "info": "Plain",
+    "lookupIndex": 0,
+    "type": "bool",
+    "docs": [],
+    "namespace": ""
+  }
+]

packages/api-contract/src/test/compare/ink_v4_flipperMetadata.test.json

@@ -0,0 +1,9 @@
+[
+  {
+    "info": "Plain",
+    "lookupIndex": 0,
+    "type": "bool",
+    "docs": [],
+    "namespace": ""
+  }
+]

packages/api-contract/src/test/contracts/ink/index.ts

@@ -6,6 +6,6 @@ import * as v0 from './v0';
 import * as v1 from './v1';
 import * as v2 from './v2';
 import * as v3 from './v3';
-// import * as v4 from './v4';
+import * as v4 from './v4';
 
-export default createVersionedExport({ v0, v1, v2, v3 });
+export default createVersionedExport({ v0, v1, v2, v3, v4 });