@pezkuwi/api-contract 16.5.20 → 16.5.22

package/package.json

@@ -18,11 +18,13 @@
     "./cjs/packageDetect.js"
   ],
   "type": "module",
-  "types": "./index.d.ts",
-  "version": "16.5.20",
+  "version": "16.5.22",
   "main": "./cjs/index.js",
-  "module": "./index.js",
+  "module": "./cjs/index.js",
+  "types": "./cjs/index.d.ts",
   "exports": {
+    "./cjs/package.json": "./cjs/package.json",
+    "./cjs/*": "./cjs/*.js",
     ".": {
       "module": {
         "types": "./index.d.ts",
@@ -261,8 +263,6 @@
         "default": "./bundle.js"
       }
     },
-    "./cjs/*": "./cjs/*.js",
-    "./cjs/package.json": "./cjs/package.json",
     "./package.json": {
       "require": "./cjs/package.json",
       "default": "./package.json"
@@ -281,7 +281,7 @@
         "default": "./packageDetect.js"
       }
     },
-    "./packageInfo": {
+    "./packageInfo.js": {
       "module": {
         "types": "./packageInfo.d.ts",
         "default": "./packageInfo.js"
@@ -295,7 +295,7 @@
         "default": "./packageInfo.js"
       }
     },
-    "./packageInfo.js": {
+    "./packageInfo": {
       "module": {
         "types": "./packageInfo.d.ts",
         "default": "./packageInfo.js"
@@ -395,13 +395,13 @@
     }
   },
   "dependencies": {
-    "@pezkuwi/api": "16.5.20",
-    "@pezkuwi/api-augment": "16.5.20",
+    "@pezkuwi/api": "16.5.22",
+    "@pezkuwi/api-augment": "16.5.22",
     "@pezkuwi/keyring": "14.0.13",
-    "@pezkuwi/types": "16.5.20",
-    "@pezkuwi/types-codec": "16.5.20",
-    "@pezkuwi/types-create": "16.5.20",
-    "@pezkuwi/types-support": "16.5.20",
+    "@pezkuwi/types": "16.5.22",
+    "@pezkuwi/types-codec": "16.5.22",
+    "@pezkuwi/types-create": "16.5.22",
+    "@pezkuwi/types-support": "16.5.22",
     "@pezkuwi/util": "14.0.13",
     "@pezkuwi/util-crypto": "14.0.13",
     "rxjs": "^7.8.1",

package/build/Abi/index.js

@@ -1,359 +0,0 @@
-import { Option, TypeRegistry } from '@pezkuwi/types';
-import { TypeDefInfo } from '@pezkuwi/types-create';
-import { assertReturn, compactAddLength, compactStripLength, isBn, isNumber, isObject, isString, isUndefined, logger, stringCamelCase, stringify, u8aConcat, u8aToHex } from '@pezkuwi/util';
-import { convertVersions, enumVersions } from './toLatestCompatible.js';
-const l = logger('Abi');
-const PRIMITIVE_ALWAYS = ['AccountId', 'AccountId20', 'AccountIndex', 'Address', 'Balance'];
-function findMessage(list, messageOrId) {
-    const message = isNumber(messageOrId)
-        ? list[messageOrId]
-        : isString(messageOrId)
-            ? list.find(({ identifier }) => [identifier, stringCamelCase(identifier)].includes(messageOrId.toString()))
-            : messageOrId;
-    return assertReturn(message, () => `Attempted to call an invalid contract interface, ${stringify(messageOrId)}`);
-}
-function getMetadata(registry, json) {
-    // this is for V1, V2, V3
-    const vx = enumVersions.find((v) => isObject(json[v]));
-    // this was added in V4
-    const jsonVersion = json.version;
-    if (!vx && jsonVersion && !enumVersions.find((v) => v === `V${jsonVersion}`)) {
-        throw new Error(`Unable to handle version ${jsonVersion}`);
-    }
-    const metadata = registry.createType('ContractMetadata', vx
-        ? { [vx]: json[vx] }
-        : jsonVersion
-            ? { [`V${jsonVersion}`]: json }
-            : { V0: json });
-    const converter = convertVersions.find(([v]) => metadata[`is${v}`]);
-    if (!converter) {
-        throw new Error(`Unable to convert ABI with version ${metadata.type} to a supported version`);
-    }
-    const upgradedMetadata = converter[1](registry, metadata[`as${converter[0]}`]);
-    return upgradedMetadata;
-}
-function isRevive(json) {
-    const source = json['source'];
-    const version = json['version'];
-    const hasContractBinary = typeof source === 'object' &&
-        source !== null &&
-        'contract_binary' in source;
-    const hasVersion = typeof version === 'number' && version >= 6;
-    return hasContractBinary || hasVersion;
-}
-function parseJson(json, chainProperties) {
-    const registry = new TypeRegistry();
-    const revive = isRevive(json);
-    const typeName = revive ? 'ContractReviveProjectInfo' : 'ContractProjectInfo';
-    const info = registry.createType(typeName, json);
-    const metadata = getMetadata(registry, json);
-    const lookup = registry.createType('PortableRegistry', { types: metadata.types }, true);
-    // attach the lookup to the registry - now the types are known
-    registry.setLookup(lookup);
-    if (chainProperties) {
-        registry.setChainProperties(chainProperties);
-    }
-    // warm-up the actual type, pre-use
-    lookup.types.forEach(({ id }) => lookup.getTypeDef(id));
-    return [json, registry, metadata, info, revive];
-}
-/**
- * @internal
- * Determines if the given input value is a ContractTypeSpec
- */
-function isTypeSpec(value) {
-    return !!value && value instanceof Map && !isUndefined(value.type) && !isUndefined(value.displayName);
-}
-/**
- * @internal
- * Determines if the given input value is an Option
- */
-function isOption(value) {
-    return !!value && value instanceof Option;
-}
-export class Abi {
-    events;
-    constructors;
-    info;
-    json;
-    messages;
-    metadata;
-    registry;
-    environment = new Map();
-    isRevive;
-    constructor(abiJson, chainProperties) {
-        [this.json, this.registry, this.metadata, this.info, this.isRevive] = parseJson(isString(abiJson)
-            ? JSON.parse(abiJson)
-            : abiJson, chainProperties);
-        this.constructors = this.metadata.spec.constructors.map((spec, index) => this.#createMessage(spec, index, {
-            isConstructor: true,
-            isDefault: spec.default.isTrue,
-            isPayable: spec.payable.isTrue,
-            returnType: spec.returnType.isSome
-                ? this.registry.lookup.getTypeDef(spec.returnType.unwrap().type)
-                : null
-        }));
-        this.events = this.metadata.spec.events.map((_, index) => this.#createEvent(index));
-        this.messages = this.metadata.spec.messages.map((spec, index) => this.#createMessage(spec, index, {
-            isDefault: spec.default.isTrue,
-            isMutating: spec.mutates.isTrue,
-            isPayable: spec.payable.isTrue,
-            returnType: spec.returnType.isSome
-                ? this.registry.lookup.getTypeDef(spec.returnType.unwrap().type)
-                : null
-        }));
-        // NOTE See the rationale for having Option<...> values in the actual
-        // ContractEnvironmentV4 structure definition in interfaces/contractsAbi
-        // (Due to conversions, the fields may not exist)
-        for (const [key, opt] of this.metadata.spec.environment.entries()) {
-            if (isOption(opt)) {
-                if (opt.isSome) {
-                    const value = opt.unwrap();
-                    if (isBn(value)) {
-                        this.environment.set(key, value);
-                    }
-                    else if (isTypeSpec(value)) {
-                        this.environment.set(key, this.registry.lookup.getTypeDef(value.type));
-                    }
-                    else {
-                        throw new Error(`Invalid environment definition for ${key}:: Expected either Number or ContractTypeSpec`);
-                    }
-                }
-            }
-            else {
-                throw new Error(`Expected Option<*> definition for ${key} in ContractEnvironment`);
-            }
-        }
-    }
-    /**
-     * Warning: Unstable API, bound to change
-     */
-    decodeEvent(record) {
-        switch (this.metadata.version.toString()) {
-            // earlier version are hoisted to v4
-            case '4':
-                return this.#decodeEventV4(record);
-            case '5':
-                return this.#decodeEventV5(record);
-            // Latest
-            default:
-                return this.#decodeEventV6(record);
-        }
-    }
-    #decodeEventV6 = (record) => {
-        const topics = record.event.data[2];
-        // Try to match by signature topic (first topic)
-        const signatureTopic = topics[0];
-        const data = record.event.data[1];
-        if (signatureTopic) {
-            const event = this.events.find((e) => e.signatureTopic !== undefined && e.signatureTopic !== null && e.signatureTopic === signatureTopic.toHex());
-            // Early return if event found by signature topic
-            if (event) {
-                return event.fromU8a(data);
-            }
-        }
-        // If no event returned yet, it might be anonymous
-        const amountOfTopics = topics.length;
-        const potentialEvents = this.events.filter((e) => {
-            // event can't have a signature topic
-            if (e.signatureTopic !== null && e.signatureTopic !== undefined) {
-                return false;
-            }
-            // event should have same amount of indexed fields as emitted topics
-            const amountIndexed = e.args.filter((a) => a.indexed).length;
-            if (amountIndexed !== amountOfTopics) {
-                return false;
-            }
-            // If all conditions met, it's a potential event
-            return true;
-        });
-        if (potentialEvents.length === 1) {
-            return potentialEvents[0].fromU8a(data);
-        }
-        throw new Error('Unable to determine event');
-    };
-    #decodeEventV5 = (record) => {
-        // Find event by first topic, which potentially is the signature_topic
-        const signatureTopic = record.topics[0];
-        const data = record.event.data[1];
-        if (signatureTopic) {
-            const event = this.events.find((e) => e.signatureTopic !== undefined && e.signatureTopic !== null && e.signatureTopic === signatureTopic.toHex());
-            // Early return if event found by signature topic
-            if (event) {
-                return event.fromU8a(data);
-            }
-        }
-        // If no event returned yet, it might be anonymous
-        const amountOfTopics = record.topics.length;
-        const potentialEvents = this.events.filter((e) => {
-            // event can't have a signature topic
-            if (e.signatureTopic !== null && e.signatureTopic !== undefined) {
-                return false;
-            }
-            // event should have same amount of indexed fields as emitted topics
-            const amountIndexed = e.args.filter((a) => a.indexed).length;
-            if (amountIndexed !== amountOfTopics) {
-                return false;
-            }
-            // If all conditions met, it's a potential event
-            return true;
-        });
-        if (potentialEvents.length === 1) {
-            return potentialEvents[0].fromU8a(data);
-        }
-        throw new Error('Unable to determine event');
-    };
-    #decodeEventV4 = (record) => {
-        const data = record.event.data[1];
-        const index = data[0];
-        const event = this.events[index];
-        if (!event) {
-            throw new Error(`Unable to find event with index ${index}`);
-        }
-        return event.fromU8a(data.subarray(1));
-    };
-    /**
-     * Warning: Unstable API, bound to change
-     */
-    decodeConstructor(data) {
-        return this.#decodeMessage('message', this.constructors, data);
-    }
-    /**
-     * Warning: Unstable API, bound to change
-     */
-    decodeMessage(data) {
-        return this.#decodeMessage('message', this.messages, data);
-    }
-    findConstructor(constructorOrId) {
-        return findMessage(this.constructors, constructorOrId);
-    }
-    findMessage(messageOrId) {
-        return findMessage(this.messages, messageOrId);
-    }
-    #createArgs = (args, spec) => {
-        return args.map(({ label, type }, index) => {
-            try {
-                if (!isObject(type)) {
-                    throw new Error('Invalid type definition found');
-                }
-                const displayName = type.displayName.length
-                    ? type.displayName[type.displayName.length - 1].toString()
-                    : undefined;
-                const camelName = stringCamelCase(label);
-                if (displayName && PRIMITIVE_ALWAYS.includes(displayName)) {
-                    return {
-                        name: camelName,
-                        type: {
-                            info: TypeDefInfo.Plain,
-                            type: displayName
-                        }
-                    };
-                }
-                const typeDef = this.registry.lookup.getTypeDef(type.type);
-                return {
-                    name: camelName,
-                    type: displayName && !typeDef.type.startsWith(displayName)
-                        ? { displayName, ...typeDef }
-                        : typeDef
-                };
-            }
-            catch (error) {
-                l.error(`Error expanding argument ${index} in ${stringify(spec)}`);
-                throw error;
-            }
-        });
-    };
-    #createMessageParams = (args, spec) => {
-        return this.#createArgs(args, spec);
-    };
-    #createEventParams = (args, spec) => {
-        const params = this.#createArgs(args, spec);
-        return params.map((p, index) => ({ ...p, indexed: args[index].indexed.toPrimitive() }));
-    };
-    #createEvent = (index) => {
-        // TODO TypeScript would narrow this type to the correct version,
-        // but version is `Text` so I need to call `toString()` here,
-        // which breaks the type inference.
-        switch (this.metadata.version.toString()) {
-            case '4':
-                return this.#createEventV4(this.metadata.spec.events[index], index);
-            default:
-                return this.#createEventV5(this.metadata.spec.events[index], index);
-        }
-    };
-    #createEventV5 = (spec, index) => {
-        const args = this.#createEventParams(spec.args, spec);
-        const event = {
-            args,
-            docs: spec.docs.map((d) => d.toString()),
-            fromU8a: (data) => ({
-                args: this.#decodeArgs(args, data),
-                event
-            }),
-            identifier: [spec.module_path, spec.label].join('::'),
-            index,
-            signatureTopic: spec.signature_topic.isSome ? spec.signature_topic.unwrap().toHex() : null
-        };
-        return event;
-    };
-    #createEventV4 = (spec, index) => {
-        const args = this.#createEventParams(spec.args, spec);
-        const event = {
-            args,
-            docs: spec.docs.map((d) => d.toString()),
-            fromU8a: (data) => ({
-                args: this.#decodeArgs(args, data),
-                event
-            }),
-            identifier: spec.label.toString(),
-            index
-        };
-        return event;
-    };
-    #createMessage = (spec, index, add = {}) => {
-        const args = this.#createMessageParams(spec.args, spec);
-        const identifier = spec.label.toString();
-        const message = {
-            ...add,
-            args,
-            docs: spec.docs.map((d) => d.toString()),
-            fromU8a: (data) => ({
-                args: this.#decodeArgs(args, data),
-                message
-            }),
-            identifier,
-            index,
-            isDefault: spec.default.isTrue,
-            method: stringCamelCase(identifier),
-            path: identifier.split('::').map((s) => stringCamelCase(s)),
-            selector: spec.selector,
-            toU8a: (params) => this.#encodeMessageArgs(spec, args, params)
-        };
-        return message;
-    };
-    #decodeArgs = (args, data) => {
-        // for decoding we expect the input to be just the arg data, no selectors
-        // no length added (this allows use with events as well)
-        let offset = 0;
-        return args.map(({ type: { lookupName, type } }) => {
-            const value = this.registry.createType(lookupName || type, data.subarray(offset));
-            offset += value.encodedLength;
-            return value;
-        });
-    };
-    #decodeMessage = (type, list, data) => {
-        const [, trimmed] = compactStripLength(data);
-        const selector = trimmed.subarray(0, 4);
-        const message = list.find((m) => m.selector.eq(selector));
-        if (!message) {
-            throw new Error(`Unable to find ${type} with selector ${u8aToHex(selector)}`);
-        }
-        return message.fromU8a(trimmed.subarray(4));
-    };
-    #encodeMessageArgs = ({ label, selector }, args, data) => {
-        if (data.length !== args.length) {
-            throw new Error(`Expected ${args.length} arguments to contract message '${label.toString()}', found ${data.length}`);
-        }
-        return compactAddLength(u8aConcat(this.registry.createType('ContractSelector', selector).toU8a(), ...args.map(({ type: { lookupName, type } }, index) => this.registry.createType(lookupName || type, data[index]).toU8a())));
-    };
-}

package/build/Abi/toLatestCompatible.js

@@ -1,30 +0,0 @@
-import { v0ToV1 } from './toV1.js';
-import { v1ToV2 } from './toV2.js';
-import { v2ToV3 } from './toV3.js';
-import { v3ToV4 } from './toV4.js';
-export const enumVersions = ['V6', 'V5', 'V4', 'V3', 'V2', 'V1'];
-function createConverter(next, step) {
-    return (registry, input) => next(registry, step(registry, input));
-}
-export function v6ToLatestCompatible(_registry, v6) {
-    return v6;
-}
-export function v5ToLatestCompatible(_registry, v5) {
-    return v5;
-}
-export function v4ToLatestCompatible(_registry, v4) {
-    return v4;
-}
-export const v3ToLatestCompatible = /*#__PURE__*/ createConverter(v4ToLatestCompatible, v3ToV4);
-export const v2ToLatestCompatible = /*#__PURE__*/ createConverter(v3ToLatestCompatible, v2ToV3);
-export const v1ToLatestCompatible = /*#__PURE__*/ createConverter(v2ToLatestCompatible, v1ToV2);
-export const v0ToLatestCompatible = /*#__PURE__*/ createConverter(v1ToLatestCompatible, v0ToV1);
-export const convertVersions = [
-    ['V6', v6ToLatestCompatible],
-    ['V5', v5ToLatestCompatible],
-    ['V4', v4ToLatestCompatible],
-    ['V3', v3ToLatestCompatible],
-    ['V2', v2ToLatestCompatible],
-    ['V1', v1ToLatestCompatible],
-    ['V0', v0ToLatestCompatible]
-];

package/build/Abi/toV1.js

@@ -1,21 +0,0 @@
-import { convertSiV0toV1 } from '@pezkuwi/types';
-import { objectSpread } from '@pezkuwi/util';
-function v0ToV1Names(all) {
-    return all.map((e) => objectSpread({}, e, {
-        name: Array.isArray(e.name)
-            ? e.name
-            : [e.name]
-    }));
-}
-export function v0ToV1(registry, v0) {
-    if (!v0.metadataVersion.length) {
-        throw new Error('Invalid format for V0 (detected) contract metadata');
-    }
-    return registry.createType('ContractMetadataV1', objectSpread({}, v0, {
-        spec: objectSpread({}, v0.spec, {
-            constructors: v0ToV1Names(v0.spec.constructors),
-            messages: v0ToV1Names(v0.spec.messages)
-        }),
-        types: convertSiV0toV1(registry, v0.types)
-    }));
-}

package/build/Abi/toV2.js

@@ -1,27 +0,0 @@
-import { objectSpread } from '@pezkuwi/util';
-const ARG_TYPES = {
-    ContractConstructorSpec: 'ContractMessageParamSpecV2',
-    ContractEventSpec: 'ContractEventParamSpecV2',
-    ContractMessageSpec: 'ContractMessageParamSpecV2'
-};
-function v1ToV2Label(entry) {
-    return objectSpread({}, entry, {
-        label: Array.isArray(entry.name)
-            ? entry.name.join('::')
-            : entry.name
-    });
-}
-function v1ToV2Labels(registry, outType, all) {
-    return all.map((e) => registry.createType(`${outType}V2`, objectSpread(v1ToV2Label(e), {
-        args: e.args.map((a) => registry.createType(ARG_TYPES[outType], v1ToV2Label(a)))
-    })));
-}
-export function v1ToV2(registry, v1) {
-    return registry.createType('ContractMetadataV2', objectSpread({}, v1, {
-        spec: objectSpread({}, v1.spec, {
-            constructors: v1ToV2Labels(registry, 'ContractConstructorSpec', v1.spec.constructors),
-            events: v1ToV2Labels(registry, 'ContractEventSpec', v1.spec.events),
-            messages: v1ToV2Labels(registry, 'ContractMessageSpec', v1.spec.messages)
-        })
-    }));
-}

package/build/Abi/toV3.js

@@ -1,10 +0,0 @@
-import { objectSpread } from '@pezkuwi/util';
-export function v2ToV3(registry, v2) {
-    return registry.createType('ContractMetadataV3', objectSpread({}, v2, {
-        spec: objectSpread({}, v2.spec, {
-            constructors: v2.spec.constructors.map((c) => 
-            // V3 introduces the payable flag on constructors, for <V3, it is always true
-            registry.createType('ContractConstructorSpecV3', objectSpread({}, c, { payable: true })))
-        })
-    }));
-}

package/build/Abi/toV4.js

@@ -1,10 +0,0 @@
-import { objectSpread } from '@pezkuwi/util';
-export function v3ToV4(registry, v3) {
-    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)))
-        }),
-        version: registry.createType('Text', '4')
-    }));
-}