@pezkuwi/types 16.5.8 → 16.5.9

package/build-deno/metadata/PortableRegistry/index.ts

@@ -1,3 +0,0 @@
-
-export { PortableRegistry } from './PortableRegistry.ts';
-export { toV1 as convertSiV0toV1 } from './toV1.ts';

package/build-deno/metadata/PortableRegistry/toV1.ts

@@ -1,128 +0,0 @@
-
-import type { PortableType, Si0Field, Si0LookupTypeId, Si0Path, Si0Type, Si0TypeDefArray, Si0TypeDefBitSequence, Si0TypeDefComposite, Si0TypeDefPrimitive, Si0TypeDefSequence, Si0TypeDefVariant, Si1Field, Si1TypeDef, SiTypeDef } from '../../interfaces/index.ts';
-import type { Registry } from '../../types/index.ts';
-
-import { assertUnreachable } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-function convertType (key: 'Compact' | 'Sequence'): (registry: Registry, si: Si0TypeDefSequence) => SiTypeDef {
-  return (registry: Registry, { type }: Si0TypeDefSequence) =>
-    registry.createType('Si1TypeDef', {
-      [key]: {
-        type: type.toNumber()
-      }
-    });
-}
-
-function convertArray (registry: Registry, { len, type }: Si0TypeDefArray): Si1TypeDef {
-  return registry.createType('Si1TypeDef', {
-    Array: {
-      len,
-      type: type.toNumber()
-    }
-  });
-}
-
-function convertBitSequence (registry: Registry, { bitOrderType, bitStoreType }: Si0TypeDefBitSequence): Si1TypeDef {
-  return registry.createType('Si1TypeDef', {
-    BitSequence: {
-      bitOrderType: bitOrderType.toNumber(),
-      bitStoreType: bitStoreType.toNumber()
-    }
-  });
-}
-
-const convertCompact = convertType('Compact');
-
-function convertComposite (registry: Registry, { fields }: Si0TypeDefComposite): Si1TypeDef {
-  return registry.createType('Si1TypeDef', {
-    Composite: {
-      fields: convertFields(registry, fields)
-    }
-  });
-}
-
-function convertFields (registry: Registry, fields: Si0Field[]): Si1Field[] {
-  return fields.map(({ docs, name, type, typeName }) =>
-    registry.createType('Si1Field', {
-      docs,
-      name,
-      type: type.toNumber(),
-      typeName
-    })
-  );
-}
-
-function convertPhantom (registry: Registry, path: Si0Path): Si1TypeDef {
-  console.warn(`Converting phantom type ${path.map((p) => p.toString()).join('::')} to empty tuple`);
-
-  return registry.createType('Si1TypeDef', {
-    Tuple: []
-  });
-}
-
-function convertPrimitive (registry: Registry, prim: Si0TypeDefPrimitive): Si1TypeDef {
-  return registry.createType('Si1TypeDef', {
-    Primitive: prim.toString()
-  });
-}
-
-const convertSequence = convertType('Sequence');
-
-function convertTuple (registry: Registry, types: Si0LookupTypeId[]): Si1TypeDef {
-  return registry.createType('Si1TypeDef', {
-    Tuple: types.map((t) => t.toNumber())
-  });
-}
-
-function convertVariant (registry: Registry, { variants }: Si0TypeDefVariant): Si1TypeDef {
-  return registry.createType('Si1TypeDef', {
-    Variant: {
-      variants: variants.map(({ discriminant, docs, fields, name }, index) =>
-        registry.createType('Si1Variant', {
-          docs,
-          fields: convertFields(registry, fields),
-          index: discriminant.isSome
-            ? discriminant.unwrap().toNumber()
-            : index,
-          name
-        })
-      )
-    }
-  });
-}
-
-function convertDef (registry: Registry, { def, path }: Si0Type): Si1TypeDef {
-  let result: Si1TypeDef;
-
-  switch (def.type) {
-    case 'Array': result = convertArray(registry, def.asArray); break;
-    case 'BitSequence': result = convertBitSequence(registry, def.asBitSequence); break;
-    case 'Compact': result = convertCompact(registry, def.asCompact); break;
-    case 'Composite': result = convertComposite(registry, def.asComposite); break;
-    case 'Phantom': result = convertPhantom(registry, path); break;
-    case 'Primitive': result = convertPrimitive(registry, def.asPrimitive); break;
-    case 'Sequence': result = convertSequence(registry, def.asSequence); break;
-    case 'Tuple': result = convertTuple(registry, def.asTuple); break;
-    case 'Variant': result = convertVariant(registry, def.asVariant); break;
-    default: assertUnreachable(def.type);
-  }
-
-  return result;
-}
-
-export function toV1 (registry: Registry, types: Si0Type[]): PortableType[] {
-  return types.map((t, index) =>
-    registry.createType('PortableType', {
-      // offsets are +1 from v0
-      id: index + 1,
-      type: {
-        def: convertDef(registry, t),
-        docs: [],
-        params: t.params.map((p) => registry.createType('Si1TypeParameter', {
-          type: p.toNumber()
-        })),
-        path: t.path.map((p) => p.toString())
-      }
-    })
-  );
-}

package/build-deno/metadata/README.md

@@ -1,10 +0,0 @@
-# metadata update
-
-0. New branch :)
-0. Start the node, typically via `cargo run --release -- purge-chain -y --dev && cargo run --release -- --dev` ([types-support/src/metadata/README.md](../../../types-support/src/metadata/README.md) has more information for specific chains)
-0. Retrieve the metadata `curl -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method": "state_getMetadata", "params":[]}' http://localhost:9933`
-0. Copy into the latest version folder per node type in `types-support/src/metadata` eg. `types-support/src/metadata/v14/bizinikiwi-hex.json`
-0. Re-build the interfaces `yarn build:interfaces`
-0. Run Metadata tests, `yarn test:one packages/types/src/metadata`
-0. All tests
-0. Make PR

package/build-deno/metadata/decorate/constants/index.ts

@@ -1,37 +0,0 @@
-
-import type { Registry } from 'https://deno.land/x/pezkuwi/types-codec/types/index.ts';
-import type { MetadataLatest, PezpalletConstantMetadataLatest } from '../../../interfaces/index.ts';
-import type { ConstantCodec, Constants } from '../types.ts';
-
-import { hexToU8a, lazyMethod, lazyMethods, stringCamelCase } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-import { objectNameToCamel } from '../util.ts';
-
-/** @internal */
-export function decorateConstants (registry: Registry, { pallets }: MetadataLatest, _version: number): Constants {
-  const result: Constants = {};
-
-  for (let i = 0, count = pallets.length; i < count; i++) {
-    const { constants, name } = pallets[i];
-
-    if (!constants.isEmpty) {
-      lazyMethod(result, stringCamelCase(name), () =>
-        lazyMethods(
-          {},
-          constants,
-          (constant: PezpalletConstantMetadataLatest): ConstantCodec => {
-            const codec = registry.createTypeUnsafe<ConstantCodec>(registry.createLookupType(constant.type), [hexToU8a(constant.value.toHex())]);
-
-            // We are casting here since we are assigning to a read-only property
-            (codec as { meta: PezpalletConstantMetadataLatest }).meta = constant;
-
-            return codec;
-          },
-          objectNameToCamel
-        )
-      );
-    }
-  }
-
-  return result;
-}

package/build-deno/metadata/decorate/errors/index.ts

@@ -1,56 +0,0 @@
-
-import type { Text, u8 } from 'https://deno.land/x/pezkuwi/types-codec/mod.ts';
-import type { Registry } from 'https://deno.land/x/pezkuwi/types-codec/types/index.ts';
-import type { DispatchErrorModule, DispatchErrorModuleU8, DispatchErrorModuleU8a, MetadataLatest, SiField, SiVariant } from '../../../interfaces/index.ts';
-import type { PortableRegistry } from '../../../metadata/index.ts';
-import type { Errors, IsError } from '../types.ts';
-
-import { isCodec, isU8a, lazyMethod, objectSpread, stringCamelCase } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-import { lazyVariants } from '../../../create/lazy.ts';
-import { objectNameToString } from '../util.ts';
-
-interface ItemMeta {
-  args: string[];
-  name: Text;
-  fields: SiField[];
-  index: u8;
-  docs: Text[];
-}
-
-export function variantToMeta (lookup: PortableRegistry, variant: SiVariant): ItemMeta {
-  return objectSpread(
-    { args: variant.fields.map(({ type }) => lookup.getTypeDef(type).type) },
-    variant
-  );
-}
-
-/** @internal */
-export function decorateErrors (registry: Registry, { lookup, pallets }: MetadataLatest, version: number): Errors {
-  const result: Errors = {};
-
-  for (let i = 0, count = pallets.length; i < count; i++) {
-    const { errors, index, name } = pallets[i];
-
-    if (errors.isSome) {
-      const sectionIndex = version >= 12 ? index.toNumber() : i;
-
-      lazyMethod(result, stringCamelCase(name), () =>
-        lazyVariants(lookup, errors.unwrap(), objectNameToString, (variant: SiVariant): IsError => ({
-          // We sprinkle in isCodec & isU8a to ensure we are dealing with the correct objects
-          is: (errorMod: DispatchErrorModule | DispatchErrorModuleU8 | DispatchErrorModuleU8a) =>
-            isCodec(errorMod) &&
-            isCodec(errorMod.index) &&
-            errorMod.index.eq(sectionIndex) && (
-              isU8a(errorMod.error)
-                ? errorMod.error[0] === variant.index.toNumber()
-                : isCodec(errorMod.error) && errorMod.error.eq(variant.index)
-            ),
-          meta: registry.createTypeUnsafe('ErrorMetadataLatest', [variantToMeta(lookup, variant)])
-        }))
-      );
-    }
-  }
-
-  return result;
-}

package/build-deno/metadata/decorate/events/index.ts

@@ -1,40 +0,0 @@
-
-import type { AnyTuple, Registry } from 'https://deno.land/x/pezkuwi/types-codec/types/index.ts';
-import type { MetadataLatest, PezpalletMetadataLatest, SiVariant } from '../../../interfaces/index.ts';
-import type { IEvent, IEventLike } from '../../../types/index.ts';
-import type { Events, IsEvent } from '../types.ts';
-
-import { isCodec, isU8a, lazyMethod, stringCamelCase } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-import { lazyVariants } from '../../../create/lazy.ts';
-import { variantToMeta } from '../errors/index.ts';
-import { objectNameToString } from '../util.ts';
-
-export function filterEventsSome ({ events }: PezpalletMetadataLatest): boolean {
-  return events.isSome;
-}
-
-/** @internal */
-export function decorateEvents (registry: Registry, { lookup, pallets }: MetadataLatest, version: number): Events {
-  const result: Events = {};
-  const filtered = pallets.filter(filterEventsSome);
-
-  for (let i = 0, count = filtered.length; i < count; i++) {
-    const { events, index, name } = filtered[i];
-    const sectionIndex = version >= 12 ? index.toNumber() : i;
-
-    lazyMethod(result, stringCamelCase(name), () =>
-      lazyVariants(lookup, events.unwrap(), objectNameToString, (variant: SiVariant): IsEvent<AnyTuple> => ({
-        // We sprinkle in isCodec & isU8a to ensure we are dealing with the correct objects
-        is: <T extends AnyTuple> (eventRecord: IEventLike): eventRecord is IEvent<T> =>
-          isCodec(eventRecord) &&
-          isU8a(eventRecord.index) &&
-          sectionIndex === eventRecord.index[0] &&
-          variant.index.eq(eventRecord.index[1]),
-        meta: registry.createTypeUnsafe('EventMetadataLatest', [variantToMeta(lookup, variant)])
-      }))
-    );
-  }
-
-  return result;
-}

package/build-deno/metadata/decorate/extrinsics/createUnchecked.ts

@@ -1,36 +0,0 @@
-
-import type { AnyJson, AnyTuple, Registry } from 'https://deno.land/x/pezkuwi/types-codec/types/index.ts';
-import type { Call, FunctionMetadataLatest } from '../../../interfaces/index.ts';
-import type { CallFunction, IMethod } from '../../../types/index.ts';
-
-import { stringCamelCase } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-function isTx <A extends AnyTuple> (tx: IMethod<AnyTuple>, callIndex: Uint8Array): tx is IMethod<A> {
-  return tx.callIndex[0] === callIndex[0] && tx.callIndex[1] === callIndex[1];
-}
-
-/** @internal */
-export function createUnchecked (registry: Registry, section: string, callIndex: Uint8Array, callMetadata: FunctionMetadataLatest): CallFunction {
-  const expectedArgs = callMetadata.fields;
-  const funcName = stringCamelCase(callMetadata.name);
-
-  const extrinsicFn = (...args: unknown[]): Call => {
-    if (expectedArgs.length !== args.length) {
-      throw new Error(`Extrinsic ${section}.${funcName} expects ${expectedArgs.length} arguments, got ${args.length}.`);
-    }
-
-    return registry.createTypeUnsafe('Call', [{ args, callIndex }, callMetadata]);
-  };
-
-  extrinsicFn.is = <A extends AnyTuple> (tx: IMethod<AnyTuple>): tx is IMethod<A> =>
-    isTx(tx, callIndex);
-
-  extrinsicFn.callIndex = callIndex;
-  extrinsicFn.meta = callMetadata;
-  extrinsicFn.method = funcName;
-  extrinsicFn.section = section;
-  extrinsicFn.toJSON = (): AnyJson =>
-    callMetadata.toJSON();
-
-  return extrinsicFn as unknown as CallFunction;
-}

package/build-deno/metadata/decorate/extrinsics/index.ts

@@ -1,64 +0,0 @@
-
-import type { Registry } from 'https://deno.land/x/pezkuwi/types-codec/types/index.ts';
-import type { MetadataLatest, PezpalletMetadataLatest, SiVariant } from '../../../interfaces/index.ts';
-import type { PortableRegistry } from '../../../metadata/index.ts';
-import type { CallFunction } from '../../../types/index.ts';
-import type { Extrinsics } from '../types.ts';
-
-import { lazyMethod, objectSpread, stringCamelCase } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-import { lazyVariants } from '../../../create/lazy.ts';
-import { getSiName } from '../../util/index.ts';
-import { objectNameToCamel } from '../util.ts';
-import { createUnchecked } from './createUnchecked.ts';
-
-export function filterCallsSome ({ calls }: PezpalletMetadataLatest): boolean {
-  return calls.isSome;
-}
-
-export function createCallFunction (registry: Registry, lookup: PortableRegistry, variant: SiVariant, sectionName: string, sectionIndex: number): CallFunction {
-  const { fields, index } = variant;
-  const count = fields.length;
-  const args = new Array<Record<string, unknown>>(count);
-
-  for (let i = 0; i < count; i++) {
-    const { name, type, typeName } = fields[i];
-
-    args[i] = objectSpread(
-      {
-        name: stringCamelCase(name.unwrapOr(`param${i}`)),
-        type: getSiName(lookup, type)
-      },
-      typeName.isSome
-        ? { typeName: typeName.unwrap() }
-        : null
-    );
-  }
-
-  return createUnchecked(
-    registry,
-    sectionName,
-    new Uint8Array([sectionIndex, index.toNumber()]),
-    registry.createTypeUnsafe('FunctionMetadataLatest', [objectSpread({ args }, variant)])
-  );
-}
-
-/** @internal */
-export function decorateExtrinsics (registry: Registry, { lookup, pallets }: MetadataLatest, version: number): Extrinsics {
-  const result: Extrinsics = {};
-  const filtered = pallets.filter(filterCallsSome);
-
-  for (let i = 0, count = filtered.length; i < count; i++) {
-    const { calls, index, name } = filtered[i];
-    const sectionName = stringCamelCase(name);
-    const sectionIndex = version >= 12 ? index.toNumber() : i;
-
-    lazyMethod(result, sectionName, () =>
-      lazyVariants(lookup, calls.unwrap(), objectNameToCamel, (variant: SiVariant) =>
-        createCallFunction(registry, lookup, variant, sectionName, sectionIndex)
-      )
-    );
-  }
-
-  return result;
-}

package/build-deno/metadata/decorate/index.ts

@@ -1,33 +0,0 @@
-
-import type { Registry } from 'https://deno.land/x/pezkuwi/types-codec/types/index.ts';
-import type { DecoratedMeta } from './types.ts';
-
-import { Metadata } from '../Metadata.ts';
-import { decorateConstants } from './constants/index.ts';
-import { decorateErrors } from './errors/index.ts';
-import { decorateEvents, filterEventsSome } from './events/index.ts';
-import { decorateExtrinsics, filterCallsSome } from './extrinsics/index.ts';
-import { decorateStorage } from './storage/index.ts';
-
-/**
- * Expands the metadata by decoration into consts, query and tx sections
- */
-export function expandMetadata (registry: Registry, metadata: Metadata): DecoratedMeta {
-  if (!(metadata instanceof Metadata)) {
-    throw new Error('You need to pass a valid Metadata instance to Decorated');
-  }
-
-  const latest = metadata.asLatest;
-  const version = metadata.version;
-
-  return {
-    consts: decorateConstants(registry, latest, version),
-    errors: decorateErrors(registry, latest, version),
-    events: decorateEvents(registry, latest, version),
-    query: decorateStorage(registry, latest, version),
-    registry,
-    tx: decorateExtrinsics(registry, latest, version)
-  };
-}
-
-export { decorateConstants, decorateErrors, decorateEvents, decorateExtrinsics, decorateStorage, filterCallsSome, filterEventsSome };

package/build-deno/metadata/decorate/storage/bizinikiwi.ts

@@ -1,54 +0,0 @@
-
-import type { Registry } from 'https://deno.land/x/pezkuwi/types-codec/types/index.ts';
-import type { StorageEntry } from '../../../primitive/types.ts';
-import type { ManualMetadata } from './util.ts';
-
-import { createRuntimeFunction } from './util.ts';
-
-type Creator = (registry: Registry) => StorageEntry;
-
-const prefix = 'Bizinikiwi';
-const section = 'bizinikiwi';
-
-function createBizinikiwiFn (method: string, key: string, meta: ManualMetadata): Creator {
-  return createRuntimeFunction({ method, prefix, section }, key, meta);
-}
-
-export const bizinikiwi: Record<string, Creator> = {
-  changesTrieConfig: createBizinikiwiFn('changesTrieConfig', ':changes_trie', {
-    docs: 'Changes trie configuration is stored under this key.',
-    type: 'u32'
-  }),
-  childStorageKeyPrefix: createBizinikiwiFn('childStorageKeyPrefix', ':child_storage:', {
-    docs: 'Prefix of child storage keys.',
-    type: 'u32'
-  }),
-  code: createBizinikiwiFn('code', ':code', {
-    docs: 'Wasm code of the runtime.',
-    type: 'Bytes'
-  }),
-  defaultChildStorageKeyPrefix: createBizinikiwiFn('defaultChildStorageKeyPrefix', ':child_storage:default:', {
-    docs: 'Prefix of the default child storage keys in the top trie.',
-    type: 'u32'
-  }),
-  extrinsicIndex: createBizinikiwiFn('extrinsicIndex', ':extrinsic_index', {
-    docs: 'Current extrinsic index (u32) is stored under this key.',
-    type: 'u32'
-  }),
-  heapPages: createBizinikiwiFn('heapPages', ':heappages', {
-    docs: 'Number of wasm linear memory pages required for execution of the runtime.',
-    type: 'u64'
-  }),
-  intrablockEntropy: createBizinikiwiFn('intrablockEntropy', ':intrablock_entropy', {
-    docs: 'Current intra-block entropy (a universally unique `[u8; 32]` value) is stored here.',
-    type: '[u8; 32]'
-  }),
-  storageVersionStorageKeyPostfix: createBizinikiwiFn('storageVersionStorageKeyPostfix', ':__STORAGE_VERSION__:', {
-    docs: 'The storage key postfix that is used to store the [`StorageVersion`] per pallet.',
-    type: 'u16'
-  }),
-  transactionLevelKey: createBizinikiwiFn('transactionLevelKey', ':transaction_level:', {
-    docs: 'The key that holds the current number of active layers.',
-    type: 'u32'
-  })
-};