@pezkuwi/api-contract 16.5.5

package/README.md

@@ -0,0 +1,3 @@
+# @pezkuwi/api-contract
+
+Interfaces to allow for the encoding and decoding of Substrate contract ABIs.

package/build/Abi/index.d.ts

@@ -0,0 +1,31 @@
+import type { ChainProperties, ContractMetadataV4, ContractMetadataV5, ContractMetadataV6, ContractProjectInfo, EventRecord } from '@pezkuwi/types/interfaces';
+import type { Codec, Registry, TypeDef } from '@pezkuwi/types/types';
+import type { AbiConstructor, AbiEvent, AbiMessage, DecodedEvent, DecodedMessage } from '../types.js';
+export type ContractMetadataSupported = ContractMetadataV4 | ContractMetadataV5 | ContractMetadataV6;
+export declare class Abi {
+    #private;
+    readonly events: AbiEvent[];
+    readonly constructors: AbiConstructor[];
+    readonly info: ContractProjectInfo;
+    readonly json: Record<string, unknown>;
+    readonly messages: AbiMessage[];
+    readonly metadata: ContractMetadataSupported;
+    readonly registry: Registry;
+    readonly environment: Map<string, TypeDef | Codec>;
+    readonly isRevive: boolean;
+    constructor(abiJson: Record<string, unknown> | string, chainProperties?: ChainProperties);
+    /**
+     * Warning: Unstable API, bound to change
+     */
+    decodeEvent(record: EventRecord): DecodedEvent;
+    /**
+     * Warning: Unstable API, bound to change
+     */
+    decodeConstructor(data: Uint8Array): DecodedMessage;
+    /**
+     * Warning: Unstable API, bound to change
+     */
+    decodeMessage(data: Uint8Array): DecodedMessage;
+    findConstructor(constructorOrId: AbiConstructor | string | number): AbiConstructor;
+    findMessage(messageOrId: AbiMessage | string | number): AbiMessage;
+}

package/build/Abi/toLatestCompatible.d.ts

@@ -0,0 +1,15 @@
+import type { ContractMetadataV4, ContractMetadataV5, ContractMetadataV6 } from '@pezkuwi/types/interfaces';
+import type { Registry } from '@pezkuwi/types/types';
+import type { ContractMetadataSupported } from './index.js';
+export declare const enumVersions: readonly ["V6", "V5", "V4", "V3", "V2", "V1"];
+type Versions = typeof enumVersions[number] | 'V0';
+type Converter = (registry: Registry, vx: any) => ContractMetadataSupported;
+export declare function v6ToLatestCompatible(_registry: Registry, v6: ContractMetadataV6): ContractMetadataV6;
+export declare function v5ToLatestCompatible(_registry: Registry, v5: ContractMetadataV5): ContractMetadataV5;
+export declare function v4ToLatestCompatible(_registry: Registry, v4: ContractMetadataV4): ContractMetadataV4;
+export declare const v3ToLatestCompatible: (registry: Registry, input: import("@pezkuwi/types/interfaces").ContractMetadataV3) => ContractMetadataSupported;
+export declare const v2ToLatestCompatible: (registry: Registry, input: import("@pezkuwi/types/interfaces").ContractMetadataV2) => ContractMetadataSupported;
+export declare const v1ToLatestCompatible: (registry: Registry, input: import("@pezkuwi/types/interfaces").ContractMetadataV1) => ContractMetadataSupported;
+export declare const v0ToLatestCompatible: (registry: Registry, input: import("@pezkuwi/types/interfaces").ContractMetadataV0) => ContractMetadataSupported;
+export declare const convertVersions: [Versions, Converter][];
+export {};

package/build/Abi/toV1.d.ts

@@ -0,0 +1,3 @@
+import type { ContractMetadataV0, ContractMetadataV1 } from '@pezkuwi/types/interfaces';
+import type { Registry } from '@pezkuwi/types/types';
+export declare function v0ToV1(registry: Registry, v0: ContractMetadataV0): ContractMetadataV1;

package/build/Abi/toV2.d.ts

@@ -0,0 +1,3 @@
+import type { ContractMetadataV1, ContractMetadataV2 } from '@pezkuwi/types/interfaces';
+import type { Registry } from '@pezkuwi/types/types';
+export declare function v1ToV2(registry: Registry, v1: ContractMetadataV1): ContractMetadataV2;

package/build/Abi/toV3.d.ts

@@ -0,0 +1,3 @@
+import type { ContractMetadataV2, ContractMetadataV3 } from '@pezkuwi/types/interfaces';
+import type { Registry } from '@pezkuwi/types/types';
+export declare function v2ToV3(registry: Registry, v2: ContractMetadataV2): ContractMetadataV3;

package/build/Abi/toV4.d.ts

@@ -0,0 +1,3 @@
+import type { ContractMetadataV3, ContractMetadataV4 } from '@pezkuwi/types/interfaces';
+import type { Registry } from '@pezkuwi/types/types';
+export declare function v3ToV4(registry: Registry, v3: ContractMetadataV3): ContractMetadataV4;

package/build/augment.d.ts

@@ -0,0 +1 @@
+import '@pezkuwi/api-augment';

package/build/base/Base.d.ts

@@ -0,0 +1,13 @@
+import type { ApiBase } from '@pezkuwi/api/base';
+import type { ApiTypes, DecorateMethod } from '@pezkuwi/api/types';
+import type { Registry } from '@pezkuwi/types/types';
+import { Abi } from '../Abi/index.js';
+export declare abstract class Base<ApiType extends ApiTypes> {
+    readonly abi: Abi;
+    readonly api: ApiBase<ApiType>;
+    protected readonly _decorateMethod: DecorateMethod<ApiType>;
+    protected readonly _isWeightV1: boolean;
+    protected readonly _isRevive: boolean;
+    constructor(api: ApiBase<ApiType>, abi: string | Record<string, unknown> | Abi, decorateMethod: DecorateMethod<ApiType>);
+    get registry(): Registry;
+}

package/build/base/Blueprint.d.ts

@@ -0,0 +1,24 @@
+import type { ApiBase } from '@pezkuwi/api/base';
+import type { ApiTypes, DecorateMethod } from '@pezkuwi/api/types';
+import type { Hash } from '@pezkuwi/types/interfaces';
+import type { ISubmittableResult } from '@pezkuwi/types/types';
+import type { Abi } from '../Abi/index.js';
+import type { MapConstructorExec } from './types.js';
+import { SubmittableResult } from '@pezkuwi/api';
+import { Base } from './Base.js';
+import { Contract } from './Contract.js';
+export type BlueprintConstructor<ApiType extends ApiTypes> = new (api: ApiBase<ApiType>, abi: string | Record<string, unknown> | Abi, codeHash: string | Hash | Uint8Array) => Blueprint<ApiType>;
+export declare class BlueprintSubmittableResult<ApiType extends ApiTypes> extends SubmittableResult {
+    readonly contract?: Contract<ApiType> | undefined;
+    constructor(result: ISubmittableResult, contract?: Contract<ApiType>);
+}
+export declare class Blueprint<ApiType extends ApiTypes> extends Base<ApiType> {
+    #private;
+    /**
+     * @description The on-chain code hash for this blueprint
+     */
+    readonly codeHash: Hash;
+    constructor(api: ApiBase<ApiType>, abi: string | Record<string, unknown> | Abi, codeHash: string | Hash | Uint8Array, decorateMethod: DecorateMethod<ApiType>);
+    get tx(): MapConstructorExec<ApiType>;
+}
+export declare function extendBlueprint<ApiType extends ApiTypes>(type: ApiType, decorateMethod: DecorateMethod<ApiType>): BlueprintConstructor<ApiType>;

package/build/base/Code.d.ts

@@ -0,0 +1,22 @@
+import type { ApiBase } from '@pezkuwi/api/base';
+import type { ApiTypes, DecorateMethod } from '@pezkuwi/api/types';
+import type { ISubmittableResult } from '@pezkuwi/types/types';
+import type { Abi } from '../Abi/index.js';
+import type { MapConstructorExec } from './types.js';
+import { SubmittableResult } from '@pezkuwi/api';
+import { Base } from './Base.js';
+import { Blueprint } from './Blueprint.js';
+import { Contract } from './Contract.js';
+export type CodeConstructor<ApiType extends ApiTypes> = new (api: ApiBase<ApiType>, abi: string | Record<string, unknown> | Abi, wasm: Uint8Array | string | Buffer | null | undefined) => Code<ApiType>;
+export declare class CodeSubmittableResult<ApiType extends ApiTypes> extends SubmittableResult {
+    readonly blueprint?: Blueprint<ApiType> | undefined;
+    readonly contract?: Contract<ApiType> | undefined;
+    constructor(result: ISubmittableResult, blueprint?: Blueprint<ApiType> | undefined, contract?: Contract<ApiType> | undefined);
+}
+export declare class Code<ApiType extends ApiTypes> extends Base<ApiType> {
+    #private;
+    readonly code: Uint8Array;
+    constructor(api: ApiBase<ApiType>, abi: string | Record<string, unknown> | Abi, wasm: Uint8Array | string | Buffer | null | undefined, decorateMethod: DecorateMethod<ApiType>);
+    get tx(): MapConstructorExec<ApiType>;
+}
+export declare function extendCode<ApiType extends ApiTypes>(type: ApiType, decorateMethod: DecorateMethod<ApiType>): CodeConstructor<ApiType>;

package/build/base/Contract.d.ts

@@ -0,0 +1,25 @@
+import type { ApiBase } from '@pezkuwi/api/base';
+import type { ApiTypes, DecorateMethod } from '@pezkuwi/api/types';
+import type { AccountId, AccountId20 } from '@pezkuwi/types/interfaces';
+import type { ISubmittableResult } from '@pezkuwi/types/types';
+import type { Abi } from '../Abi/index.js';
+import type { DecodedEvent } from '../types.js';
+import type { MapMessageQuery, MapMessageTx } from './types.js';
+import { SubmittableResult } from '@pezkuwi/api';
+import { Base } from './Base.js';
+export type ContractConstructor<ApiType extends ApiTypes> = new (api: ApiBase<ApiType>, abi: string | Record<string, unknown> | Abi, address: string | AccountId) => Contract<ApiType>;
+export declare class ContractSubmittableResult extends SubmittableResult {
+    readonly contractEvents?: DecodedEvent[] | undefined;
+    constructor(result: ISubmittableResult, contractEvents?: DecodedEvent[]);
+}
+export declare class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
+    #private;
+    /**
+     * @description The on-chain address for this contract
+     */
+    readonly address: AccountId | AccountId20;
+    constructor(api: ApiBase<ApiType>, abi: string | Record<string, unknown> | Abi, address: string | AccountId | AccountId20, decorateMethod: DecorateMethod<ApiType>);
+    get query(): MapMessageQuery<ApiType>;
+    get tx(): MapMessageTx<ApiType>;
+}
+export declare function extendContract<ApiType extends ApiTypes>(type: ApiType, decorateMethod: DecorateMethod<ApiType>): ContractConstructor<ApiType>;

package/build/base/index.d.ts

@@ -0,0 +1,3 @@
+export { Blueprint, BlueprintSubmittableResult, extendBlueprint } from './Blueprint.js';
+export { Code, CodeSubmittableResult, extendCode } from './Code.js';
+export { Contract, extendContract } from './Contract.js';

package/build/base/mock.d.ts

@@ -0,0 +1,3 @@
+import type { ApiBase } from '@pezkuwi/api/base';
+export declare const mockApi: ApiBase<"promise">;
+export declare const mockReviveApi: ApiBase<"promise">;

package/build/base/types.d.ts

@@ -0,0 +1,25 @@
+import type { Observable } from 'rxjs';
+import type { SubmittableExtrinsic } from '@pezkuwi/api/submittable/types';
+import type { ApiTypes, ObsInnerType } from '@pezkuwi/api/types';
+import type { AccountId } from '@pezkuwi/types/interfaces';
+import type { AbiMessage, BlueprintOptions, ContractCallOutcome, ContractOptions } from '../types.js';
+export interface MessageMeta {
+    readonly meta: AbiMessage;
+}
+export interface BlueprintDeploy<ApiType extends ApiTypes> extends MessageMeta {
+    (options: BlueprintOptions, ...params: unknown[]): SubmittableExtrinsic<ApiType>;
+}
+export interface ContractQuery<ApiType extends ApiTypes> extends MessageMeta {
+    (origin: AccountId | string | Uint8Array, options: ContractOptions, ...params: unknown[]): ContractCallResult<ApiType, ContractCallOutcome>;
+}
+export interface ContractTx<ApiType extends ApiTypes> extends MessageMeta {
+    (options: ContractOptions, ...params: unknown[]): SubmittableExtrinsic<ApiType>;
+}
+export type ContractGeneric<O, T> = (messageOrId: AbiMessage | string | number, options: O, ...params: unknown[]) => T;
+export type ContractCallResult<ApiType extends ApiTypes, T> = ApiType extends 'rxjs' ? Observable<T> : Promise<ObsInnerType<Observable<T>>>;
+export interface ContractCallSend<ApiType extends ApiTypes> {
+    send(account: string | AccountId | Uint8Array): ContractCallResult<ApiType, ContractCallOutcome>;
+}
+export type MapConstructorExec<ApiType extends ApiTypes> = Record<string, BlueprintDeploy<ApiType>>;
+export type MapMessageTx<ApiType extends ApiTypes> = Record<string, ContractTx<ApiType>>;
+export type MapMessageQuery<ApiType extends ApiTypes> = Record<string, ContractQuery<ApiType>>;

package/build/base/util.d.ts

@@ -0,0 +1,16 @@
+import type { SubmittableResult } from '@pezkuwi/api';
+import type { SubmittableExtrinsic } from '@pezkuwi/api/submittable/types';
+import type { ApiTypes } from '@pezkuwi/api/types';
+import type { WeightV1, WeightV2 } from '@pezkuwi/types/interfaces';
+import type { BN } from '@pezkuwi/util';
+import type { AbiConstructor, AbiMessage, BlueprintOptions, WeightAll } from '../types.js';
+import type { BlueprintDeploy, ContractGeneric } from './types.js';
+export declare const EMPTY_SALT: Uint8Array<ArrayBuffer>;
+export declare function withMeta<T extends {
+    meta: AbiMessage;
+}>(meta: AbiMessage, creator: Omit<T, 'meta'>): T;
+export declare function createBluePrintTx<ApiType extends ApiTypes, R extends SubmittableResult>(meta: AbiMessage, fn: (options: BlueprintOptions, params: unknown[]) => SubmittableExtrinsic<ApiType, R>): BlueprintDeploy<ApiType>;
+export declare function createBluePrintWithId<T>(fn: (constructorOrId: AbiConstructor | string | number, options: BlueprintOptions, params: unknown[]) => T): ContractGeneric<BlueprintOptions, T>;
+export declare function encodeSalt(salt?: Uint8Array | string | null): Uint8Array;
+export declare function convertWeight(weight: WeightV1 | WeightV2 | bigint | string | number | BN): WeightAll;
+export declare function isWeightV2(weight: WeightV1 | WeightV2 | bigint | string | number | BN): weight is WeightV2;

package/build/bundle.d.ts

@@ -0,0 +1,4 @@
+export { Abi } from './Abi/index.js';
+export { packageInfo } from './packageInfo.js';
+export * from './promise/index.js';
+export * from './rx/index.js';

package/build/index.d.ts

@@ -0,0 +1,2 @@
+import './packageDetect.js';
+export * from './bundle.js';

package/build/packageDetect.d.ts

@@ -0,0 +1 @@
+export {};

package/build/packageInfo.d.ts

@@ -0,0 +1,6 @@
+export declare const packageInfo: {
+    name: string;
+    path: string;
+    type: string;
+    version: string;
+};

package/build/promise/index.d.ts

@@ -0,0 +1,13 @@
+import type { ApiPromise } from '@pezkuwi/api';
+import type { AccountId, AccountId20, Hash } from '@pezkuwi/types/interfaces';
+import type { Abi } from '../Abi/index.js';
+import { Blueprint, Code, Contract } from '../base/index.js';
+export declare class BlueprintPromise extends Blueprint<'promise'> {
+    constructor(api: ApiPromise, abi: string | Record<string, unknown> | Abi, codeHash: string | Hash);
+}
+export declare class CodePromise extends Code<'promise'> {
+    constructor(api: ApiPromise, abi: string | Record<string, unknown> | Abi, wasm: Uint8Array | string | Buffer | null | undefined);
+}
+export declare class ContractPromise extends Contract<'promise'> {
+    constructor(api: ApiPromise, abi: string | Record<string, unknown> | Abi, address: string | AccountId | AccountId20);
+}

package/build/promise/types.d.ts

@@ -0,0 +1,3 @@
+import type { BlueprintSubmittableResult as BaseBlueprintSubmittableResult, CodeSubmittableResult as BaseCodeSubmittableResult } from '../base/index.js';
+export type BlueprintSubmittableResult = BaseBlueprintSubmittableResult<'promise'>;
+export type CodeSubmittableResult = BaseCodeSubmittableResult<'promise'>;

package/build/rx/index.d.ts

@@ -0,0 +1,13 @@
+import type { ApiRx } from '@pezkuwi/api';
+import type { AccountId, Hash } from '@pezkuwi/types/interfaces';
+import type { Abi } from '../Abi/index.js';
+import { Blueprint, Code, Contract } from '../base/index.js';
+export declare class BlueprintRx extends Blueprint<'rxjs'> {
+    constructor(api: ApiRx, abi: string | Record<string, unknown> | Abi, codeHash: string | Hash);
+}
+export declare class CodeRx extends Code<'rxjs'> {
+    constructor(api: ApiRx, abi: string | Record<string, unknown> | Abi, wasm: Uint8Array | string | Buffer | null | undefined);
+}
+export declare class ContractRx extends Contract<'rxjs'> {
+    constructor(api: ApiRx, abi: string | Record<string, unknown> | Abi, address: string | AccountId);
+}

package/build/rx/types.d.ts

@@ -0,0 +1,3 @@
+import type { BlueprintSubmittableResult as BaseBlueprintSubmittableResult, CodeSubmittableResult as BaseCodeSubmittableResult } from '../base/index.js';
+export type BlueprintSubmittableResult = BaseBlueprintSubmittableResult<'promise'>;
+export type CodeSubmittableResult = BaseCodeSubmittableResult<'promise'>;

package/build/types.d.ts

@@ -0,0 +1,79 @@
+import type { ApiBase } from '@pezkuwi/api/base';
+import type { ApiTypes } from '@pezkuwi/api/types';
+import type { Text } from '@pezkuwi/types';
+import type { ContractExecResultResult, ContractSelector, StorageDeposit, Weight, WeightV2 } from '@pezkuwi/types/interfaces';
+import type { Codec, TypeDef } from '@pezkuwi/types/types';
+import type { BN } from '@pezkuwi/util';
+import type { HexString } from '@pezkuwi/util/types';
+import type { Abi } from './index.js';
+export interface ContractBase<ApiType extends ApiTypes> {
+    readonly abi: Abi;
+    readonly api: ApiBase<ApiType>;
+    getMessage: (name: string) => AbiMessage;
+    messages: AbiMessage[];
+}
+export interface AbiParam {
+    name: string;
+    type: TypeDef;
+}
+export type AbiMessageParam = AbiParam;
+export interface AbiEventParam extends AbiParam {
+    indexed: boolean;
+}
+export interface AbiEvent {
+    args: AbiEventParam[];
+    docs: string[];
+    fromU8a: (data: Uint8Array) => DecodedEvent;
+    identifier: string;
+    index: number;
+    signatureTopic?: HexString | null;
+}
+export interface AbiMessage {
+    args: AbiMessageParam[];
+    docs: string[];
+    fromU8a: (data: Uint8Array) => DecodedMessage;
+    identifier: string;
+    index: number;
+    isConstructor?: boolean;
+    isDefault?: boolean;
+    isMutating?: boolean;
+    isPayable?: boolean;
+    method: string;
+    path: string[];
+    returnType?: TypeDef | null;
+    selector: ContractSelector;
+    toU8a: (params: unknown[]) => Uint8Array;
+}
+export type AbiConstructor = AbiMessage;
+export type InterfaceContractCalls = Record<string, Function>;
+export interface ContractCallOutcome {
+    debugMessage: Text;
+    gasConsumed: Weight;
+    gasRequired: Weight;
+    output: Codec | null;
+    result: ContractExecResultResult;
+    storageDeposit: StorageDeposit;
+}
+export interface DecodedEvent {
+    args: Codec[];
+    event: AbiEvent;
+}
+export interface DecodedMessage {
+    args: Codec[];
+    message: AbiMessage;
+}
+export interface ContractOptions {
+    gasLimit?: bigint | string | number | BN | WeightV2;
+    storageDepositLimit?: bigint | string | number | BN | null;
+    value?: bigint | BN | string | number;
+}
+export interface BlueprintOptions extends ContractOptions {
+    salt?: Uint8Array | string | null;
+}
+export interface WeightAll {
+    v1Weight: BN;
+    v2Weight: {
+        refTime: BN;
+        proofSize?: BN | undefined;
+    };
+}

package/build/util.d.ts

@@ -0,0 +1,5 @@
+import type { SubmittableResult } from '@pezkuwi/api';
+import type { EventRecord } from '@pezkuwi/types/interfaces';
+type ContractEvents = 'CodeStored' | 'ContractEmitted' | 'ContractExecution' | 'Instantiated';
+export declare function applyOnEvent<T>(result: SubmittableResult, types: ContractEvents[], fn: (records: EventRecord[]) => T, isRevive: boolean): T | undefined;
+export {};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "author": "Jaco Greeff <jacogr@gmail.com>",
+  "bugs": "https://github.com/pezkuwichain/pezkuwi-api/issues",
+  "description": "Interfaces for interacting with contracts and contract ABIs",
+  "engines": {
+    "node": ">=18"
+  },
+  "homepage": "https://github.com/pezkuwichain/pezkuwi-api/tree/master/packages/api-contract#readme",
+  "license": "Apache-2.0",
+  "name": "@pezkuwi/api-contract",
+  "repository": {
+    "directory": "packages/api-contract",
+    "type": "git",
+    "url": "https://github.com/pezkuwichain/pezkuwi-api.git"
+  },
+  "sideEffects": [
+    "./packageDetect.js",
+    "./packageDetect.cjs"
+  ],
+  "type": "module",
+  "version": "16.5.5",
+  "main": "index.js",
+  "dependencies": {
+    "@pezkuwi/api": "16.5.5",
+    "@pezkuwi/api-augment": "16.5.5",
+    "@pezkuwi/types": "16.5.5",
+    "@pezkuwi/types-codec": "16.5.5",
+    "@pezkuwi/types-create": "16.5.5",
+    "@pezkuwi/util": "14.0.5",
+    "@pezkuwi/util-crypto": "14.0.5",
+    "rxjs": "^7.8.1",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "@pezkuwi/api-augment": "16.5.5",
+    "@pezkuwi/keyring": "14.0.5",
+    "@pezkuwi/types-support": "16.5.5"
+  }
+}

package/src/Abi/Abi.spec.ts

@@ -0,0 +1,235 @@
+// Copyright 2017-2025 @polkadot/api-contract authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import type { Registry } from '@pezkuwi/types/types';
+
+import fs from 'node:fs';
+import process from 'node:process';
+
+import { TypeDefInfo } from '@pezkuwi/types/types';
+import rpcMetadata from '@pezkuwi/types-support/metadata/static-substrate-contracts-node';
+import { blake2AsHex } from '@pezkuwi/util-crypto';
+
+import { Metadata, TypeRegistry } from '../../../types/src/bundle.js';
+import abis from '../test/contracts/index.js';
+import { Abi } from './index.js';
+
+interface SpecDef {
+  messages: {
+    label: string;
+    name: string[] | string
+  }[]
+}
+
+interface JSONAbi {
+  source: {
+    compiler: string,
+    hash: string,
+    language: string,
+    wasm: string
+  },
+  spec: SpecDef;
+  V1: {
+    spec: SpecDef;
+  },
+  V2: {
+    spec: SpecDef;
+  },
+  V3: {
+    spec: SpecDef;
+  },
+  V4: {
+    spec: SpecDef;
+  }
+}
+
+function stringifyInfo (key: string, value: unknown): unknown {
+  return key === 'info' && typeof value === 'number'
+    ? TypeDefInfo[value]
+    : value;
+}
+
+function stringifyJson (registry: Registry): string {
+  const defs = registry.lookup.types.map(({ id }) =>
+    registry.lookup.getTypeDef(id)
+  );
+
+  return JSON.stringify(defs, stringifyInfo, 2);
+}
+
+describe('Abi', (): void => {
+  describe('ABI', (): void => {
+    Object.entries(abis).forEach(([abiName, _abi]) => {
+      const abi = _abi as unknown as JSONAbi;
+
+      it(`initializes from a contract ABI (${abiName})`, (): void => {
+        try {
+          const messageIds = (abi.V4 || abi.V3 || abi.V2 || abi.V1 || abi).spec.messages.map(({ label, name }) =>
+            label || (
+              Array.isArray(name)
+                ? name.join('::')
+                : name
+            )
+          );
+          const inkAbi = new Abi(abis[abiName]);
+
+          expect(inkAbi.messages.map(({ identifier }) => identifier)).toEqual(messageIds);
+        } catch (error) {
+          console.error(error);
+
+          throw error;
+        }
+      });
+    });
+  });
+
+  describe('TypeDef', (): void => {
+    for (const [abiName, abiJson] of Object.entries(abis)) {
+      it(`initializes from a contract ABI: ${abiName}`, (): void => {
+        const abi = new Abi(abiJson);
+        const registryJson = stringifyJson(abi.registry);
+        const cmpFile = new URL(`../test/compare/${abiName}.test.json`, import.meta.url);
+
+        try {
+          expect(
+            JSON.parse(registryJson)
+          ).toEqual(
+            JSON.parse(fs.readFileSync(cmpFile, 'utf-8'))
+          );
+        } catch (error) {
+          if (process.env['GITHUB_REPOSITORY']) {
+            console.error(registryJson);
+
+            throw error;
+          }
+
+          fs.writeFileSync(cmpFile, registryJson, { flag: 'w' });
+        }
+      });
+    }
+  });
+
+  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;
+
+    // manual
+    expect(bundle.source.hash).toEqual(blake2AsHex(bundle.source.wasm));
+
+    // the Codec hash
+    expect(bundle.source.hash).toEqual(abi.info.source.wasm.hash.toHex());
+
+    // the hash as per the actual Abi
+    expect(bundle.source.hash).toEqual(abi.info.source.wasmHash.toHex());
+  });
+
+  describe('Events', (): void => {
+    const registry = new TypeRegistry();
+
+    beforeAll((): void => {
+      const metadata = new Metadata(registry, rpcMetadata);
+
+      registry.setMetadata(metadata);
+    });
+
+    it('decoding <=ink!v4 event', (): void => {
+      const abiJson = abis['ink_v4_erc20Metadata'];
+
+      expect(abiJson).toBeDefined();
+      const abi = new Abi(abiJson);
+
+      const eventRecordHex =
+      '0x0001000000080360951b8baf569bca905a279c12d6ce17db7cdce23a42563870ef585129ce5dc64d010001d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d018eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a4800505a4f7e9f4eb106000000000000000c0045726332303a3a5472616e7366657200000000000000000000000000000000da2d695d3b5a304e0039e7fc4419c34fa0c1f239189c99bb72a6484f1634782b2b00c7d40fe6d84d660f3e6bed90f218e022a0909f7e1a7ea35ada8b6e003564';
+      const record = registry.createType('EventRecord', eventRecordHex);
+
+      const decodedEvent = abi.decodeEvent(record);
+
+      expect(decodedEvent.event.args.length).toEqual(3);
+      expect(decodedEvent.args.length).toEqual(3);
+      expect(decodedEvent.event.identifier).toEqual('Transfer');
+
+      const decodedEventHuman = decodedEvent.event.args.reduce((prev, cur, index) => {
+        return {
+          ...prev,
+          [cur.name]: decodedEvent.args[index].toHuman()
+        };
+      }, {});
+
+      const expectedEvent = {
+        from: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
+        to: '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
+        value: '123.4567 MUnit'
+      };
+
+      expect(decodedEventHuman).toEqual(expectedEvent);
+    });
+
+    it('decoding >=ink!v5 event', (): void => {
+      const abiJson = abis['ink_v5_erc20Metadata'];
+
+      expect(abiJson).toBeDefined();
+      const abi = new Abi(abiJson);
+
+      const eventRecordHex =
+    '0x00010000000803da17150e96b3955a4db6ad35ddeb495f722f9c1d84683113bfb096bf3faa30f2490101d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d018eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a4800505a4f7e9f4eb106000000000000000cb5b61a3e6a21a16be4f044b517c28ac692492f73c5bfd3f60178ad98c767f4cbd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48';
+      const record = registry.createType('EventRecord', eventRecordHex);
+
+      const decodedEvent = abi.decodeEvent(record);
+
+      expect(decodedEvent.event.args.length).toEqual(3);
+      expect(decodedEvent.args.length).toEqual(3);
+      expect(decodedEvent.event.identifier).toEqual('erc20::erc20::Transfer');
+
+      const decodedEventHuman = decodedEvent.event.args.reduce((prev, cur, index) => {
+        return {
+          ...prev,
+          [cur.name]: decodedEvent.args[index].toHuman()
+        };
+      }, {});
+
+      const expectedEvent = {
+        from: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
+        to: '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
+        value: '123.4567 MUnit'
+      };
+
+      expect(decodedEventHuman).toEqual(expectedEvent);
+    });
+
+    it('decoding >=ink!v5 anonymous event', (): void => {
+      const abiJson = abis['ink_v5_erc20AnonymousTransferMetadata'];
+
+      expect(abiJson).toBeDefined();
+      const abi = new Abi(abiJson);
+
+      expect(abi.events[0].identifier).toEqual('erc20::erc20::Transfer');
+      expect(abi.events[0].signatureTopic).toEqual(null);
+
+      const eventRecordWithAnonymousEventHex = '0x00010000000803538e726248a9c155911e7d99f4f474c3408630a2f6275dd501d4471c7067ad2c490101d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d018eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a4800505a4f7e9f4eb1060000000000000008d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48';
+      const record = registry.createType('EventRecord', eventRecordWithAnonymousEventHex);
+
+      const decodedEvent = abi.decodeEvent(record);
+
+      expect(decodedEvent.event.args.length).toEqual(3);
+      expect(decodedEvent.args.length).toEqual(3);
+      expect(decodedEvent.event.identifier).toEqual('erc20::erc20::Transfer');
+
+      const decodedEventHuman = decodedEvent.event.args.reduce((prev, cur, index) => {
+        return {
+          ...prev,
+          [cur.name]: decodedEvent.args[index].toHuman()
+        };
+      }, {});
+
+      const expectedEvent = {
+        from: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
+        to: '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
+        value: '123.4567 MUnit'
+      };
+
+      expect(decodedEventHuman).toEqual(expectedEvent);
+    });
+  });
+});