Add suport for latest ink! metadata (#5650)

* add v5

* add environment

* tov5

* use correct version

* decode env types

* fix tests

* remove unnecesary checks

* update fixtures

* add maxEventTopics

* get type defs for environment

* fix conversion to v4

Author: statictype

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

@@ -3,7 +3,7 @@
 
 import type { Bytes } from '@polkadot/types';
 import type { ChainProperties, ContractConstructorSpecLatest, ContractEventSpecLatest, ContractMessageParamSpecLatest, ContractMessageSpecLatest, ContractMetadata, ContractMetadataLatest, ContractProjectInfo } from '@polkadot/types/interfaces';
-import type { Codec, Registry } from '@polkadot/types/types';
+import type { Codec, Registry, TypeDef } from '@polkadot/types/types';
 import type { AbiConstructor, AbiEvent, AbiMessage, AbiParam, DecodedEvent, DecodedMessage } from '../types.js';
 
 import { TypeRegistry } from '@polkadot/types';
@@ -82,6 +82,7 @@ export class Abi {
   readonly messages: AbiMessage[];
   readonly metadata: ContractMetadataLatest;
   readonly registry: Registry;
+  readonly environment: Map<string, TypeDef | number> = new Map();
 
   constructor (abiJson: Record<string, unknown> | string, chainProperties?: ChainProperties) {
     [this.json, this.registry, this.metadata, this.info] = parseJson(
@@ -90,11 +91,18 @@ export class Abi {
         : abiJson,
       chainProperties
     );
-    this.constructors = this.metadata.spec.constructors.map((spec: ContractConstructorSpecLatest, index) =>
-      this.#createMessage(spec, index, {
+    this.constructors = this.metadata.spec.constructors.map((spec: ContractConstructorSpecLatest, index) => {
+      const typeSpec = spec.returnType.unwrapOr(null);
+
+      return this.#createMessage(spec, index, {
         isConstructor: true,
-        isPayable: spec.payable.isTrue
-      })
+        isDefault: spec.default.isTrue,
+        isPayable: spec.payable.isTrue,
+        returnType: typeSpec
+          ? this.registry.lookup.getTypeDef(typeSpec.type)
+          : null
+      });
+    }
     );
     this.events = this.metadata.spec.events.map((spec: ContractEventSpecLatest, index) =>
       this.#createEvent(spec, index)
@@ -103,13 +111,27 @@ export class Abi {
       const typeSpec = spec.returnType.unwrapOr(null);
 
       return this.#createMessage(spec, index, {
+        isDefault: spec.default.isTrue,
         isMutating: spec.mutates.isTrue,
         isPayable: spec.payable.isTrue,
         returnType: typeSpec
           ? this.registry.lookup.getTypeDef(typeSpec.type)
           : null
       });
     });
+    const rawEnv = this.metadata.spec.environment.unwrapOr(null);
+
+    if (rawEnv) {
+      for (const [key, value] of rawEnv.entries()) {
+        const typeSpec = value.toPrimitive();
+
+        if (typeof typeSpec === 'object' && typeSpec !== null && 'type' in typeSpec) {
+          this.environment.set(key, this.registry.lookup.getTypeDef(typeSpec.type as number));
+        } else {
+          this.environment.set(key, typeSpec as number);
+        }
+      }
+    }
   }
 
   /**
@@ -215,6 +237,7 @@ export class Abi {
       }),
       identifier,
       index,
+      isDefault: spec.default.isTrue,
       method: stringCamelCase(identifier),
       path: identifier.split('::').map((s) => stringCamelCase(s)),
       selector: spec.selector,

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

@@ -4,6 +4,17 @@
 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;
+import { objectSpread } from '@polkadot/util';
+
+export function v3ToV4 (registry: Registry, v3: ContractMetadataV3): ContractMetadataV4 {
+  return registry.createType('ContractMetadataV4', objectSpread({}, v3, {
+    spec: objectSpread({}, v3.spec, {
+      constructors: v3.spec.constructors.map((c) =>
+        registry.createType('ContractConstructorSpecV4', objectSpread({}, c))
+      ),
+      messages: v3.spec.messages.map((m) =>
+        registry.createType('ContractMessageSpecV3', objectSpread({}, m))
+      )
+    })
+  }));
 }

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

@@ -5,5 +5,151 @@
     "type": "bool",
     "docs": [],
     "namespace": ""
+  },
+  {
+    "info": "Result",
+    "lookupIndex": 1,
+    "type": "Result<Null, InkPrimitivesLangError>",
+    "docs": [],
+    "namespace": "Result",
+    "sub": [
+      {
+        "name": "Ok",
+        "info": "Null",
+        "lookupIndex": 2,
+        "type": "Null",
+        "docs": [],
+        "namespace": ""
+      },
+      {
+        "name": "Error",
+        "docs": [],
+        "info": "Si",
+        "lookupIndex": 3,
+        "lookupName": "InkPrimitivesLangError",
+        "type": "Lookup3"
+      }
+    ]
+  },
+  {
+    "info": "Null",
+    "lookupIndex": 2,
+    "type": "Null",
+    "docs": [],
+    "namespace": ""
+  },
+  {
+    "info": "Enum",
+    "lookupIndex": 3,
+    "lookupName": "InkPrimitivesLangError",
+    "type": "{\"_enum\":[\"__Unused0\",\"CouldNotReadInput\"]}",
+    "docs": [],
+    "namespace": "ink_primitives::LangError",
+    "sub": [
+      {
+        "index": 0,
+        "info": "Null",
+        "name": "__Unused0",
+        "type": "Null"
+      },
+      {
+        "info": "Null",
+        "type": "Null",
+        "index": 1,
+        "name": "CouldNotReadInput"
+      }
+    ]
+  },
+  {
+    "info": "Result",
+    "lookupIndex": 4,
+    "type": "Result<bool, InkPrimitivesLangError>",
+    "docs": [],
+    "namespace": "Result",
+    "sub": [
+      {
+        "name": "Ok",
+        "info": "Plain",
+        "lookupIndex": 0,
+        "type": "bool",
+        "docs": [],
+        "namespace": ""
+      },
+      {
+        "name": "Error",
+        "docs": [],
+        "info": "Si",
+        "lookupIndex": 3,
+        "lookupName": "InkPrimitivesLangError",
+        "type": "Lookup3"
+      }
+    ]
+  },
+  {
+    "info": "Plain",
+    "lookupIndex": 5,
+    "type": "AccountId",
+    "docs": [],
+    "namespace": "ink_primitives::types::AccountId",
+    "lookupNameRoot": "InkPrimitivesAccountId"
+  },
+  {
+    "info": "VecFixed",
+    "lookupIndex": 6,
+    "type": "[u8;32]",
+    "docs": [],
+    "namespace": "",
+    "length": 32,
+    "sub": {
+      "info": "Plain",
+      "lookupIndex": 7,
+      "type": "u8",
+      "docs": [],
+      "namespace": ""
+    }
+  },
+  {
+    "info": "Plain",
+    "lookupIndex": 7,
+    "type": "u8",
+    "docs": [],
+    "namespace": ""
+  },
+  {
+    "info": "Plain",
+    "lookupIndex": 8,
+    "type": "u128",
+    "docs": [],
+    "namespace": ""
+  },
+  {
+    "info": "Plain",
+    "lookupIndex": 9,
+    "type": "Hash",
+    "docs": [],
+    "namespace": "ink_primitives::types::Hash",
+    "lookupNameRoot": "InkPrimitivesHash"
+  },
+  {
+    "info": "Plain",
+    "lookupIndex": 10,
+    "type": "u64",
+    "docs": [],
+    "namespace": ""
+  },
+  {
+    "info": "Plain",
+    "lookupIndex": 11,
+    "type": "u32",
+    "docs": [],
+    "namespace": ""
+  },
+  {
+    "info": "Plain",
+    "lookupIndex": 12,
+    "type": "NoChainExtension",
+    "docs": [],
+    "namespace": "ink_env::types::NoChainExtension",
+    "lookupNameRoot": "InkEnvNoChainExtension"
   }
 ]