feat: add additionalTypes, and typesBundle to getRegistryBase

package.json

@@ -13,7 +13,8 @@
  "version": "yarn install && git stage yarn.lock",
  "build": "lerna run build",
  "build:workspace": "substrate-exec-rimraf $INIT_CWD/lib/ && cd $INIT_CWD && tsc -p tsconfig.build.json",
- "lint": "substrate-dev-run-lint --fix",
+ "lint": "substrate-dev-run-lint",
+ "lint:fix": "substrate-dev-run-lint --fix",
  "lint:ci": "substrate-dev-run-lint",
  "test": "substrate-exec-jest --detectOpenHandles",
  "test:watch": "substrate-exec-jest --watch",

packages/txwrapper-core/src/core/metadata/getRegistryBase.spec.ts

@@ -30,4 +30,47 @@ describe('getRegistryBase', () => {
  Buffer.from(callsOnlyRegistry.metadata.toHex(), 'utf-8').byteLength
  );
  });
+
+ it('Should accept a `typesBundle` and properly set the known types', () => {
+ const registry = new TypeRegistry();
+ const typesBundle = {
+ spec: {
+ polkadot: {
+ types: [
+ {
+ minmax: [0, null],
+ types: {
+ TestingType: 'u32',
+ },
+ },
+ ],
+ },
+ },
+ };
+
+ const testRegistry = getRegistryBase({
+ chainProperties: knownChainProperties['polkadot'],
+ specTypes: getSpecTypes(registry, 'Polkadot', 'polkadot', 9122),
+ metadataRpc: KUSAMA_TEST_OPTIONS.metadataRpc,
+ typesBundle,
+ });
+ expect(
+ testRegistry.knownTypes.typesBundle?.spec?.['polkadot'].types?.[0].types
+ ).toEqual({
+ TestingType: 'u32',
+ });
+ });
+
+ it('Should inject types when `additionalTypes` is available', () => {
+ const registry = new TypeRegistry();
+ const testRegistry = getRegistryBase({
+ chainProperties: knownChainProperties['polkadot'],
+ specTypes: getSpecTypes(registry, 'Polkadot', 'polkadot', 9122),
+ metadataRpc: KUSAMA_TEST_OPTIONS.metadataRpc,
+ additionalTypes: { TestingType: 'u32' },
+ });
+
+ const testType = testRegistry.createType('TestingType', 10);
+ expect(testType.toString()).toEqual('10');
+ });
 });

packages/txwrapper-core/src/core/metadata/getRegistryBase.ts

@@ -1,6 +1,10 @@
 import { TypeRegistry } from '@polkadot/types';
 import { ExtDef } from '@polkadot/types/extrinsic/signedExtensions/types';
-import { AnyJson, RegistryTypes } from '@polkadot/types/types';
+import {
+ AnyJson,
+ OverrideBundleType,
+ RegistryTypes,
+} from '@polkadot/types/types';
 
 import { ChainProperties } from '../../types';
 import { createMetadata } from './createMetadata';
@@ -30,6 +34,14 @@ export interface GetRegistryBaseArgs {
  * User extensions used to inject into the type registry
  */
  userExtensions?: ExtDef;
+ /**
+ * OverrideTypesBundle to set to registry
+ */
+ typesBundle?: OverrideBundleType;
+ /**
+ * Additional types to register in the registry.
+ */
+ additionalTypes?: RegistryTypes;
 }
 
 /**
@@ -42,6 +54,8 @@ export function getRegistryBase({
  asCallsOnlyArg,
  signedExtensions,
  userExtensions,
+ typesBundle,
+ additionalTypes,
 }: GetRegistryBaseArgs): TypeRegistry {
  const registry = new TypeRegistry();
 
@@ -53,8 +67,14 @@ export function getRegistryBase({
 
  registry.register(specTypes);
 
+ if (additionalTypes) {
+ registry.register(additionalTypes);
+ }
+
  registry.setMetadata(generatedMetadata, signedExtensions, userExtensions);
 
+ registry.setKnownTypes({ typesBundle });
+
  // Register the chain properties for this registry
  registry.setChainProperties(
  registry.createType('ChainProperties', chainProperties)

packages/txwrapper-core/src/types/registry.ts

@@ -1,4 +1,5 @@
 import { ExtDef } from '@polkadot/types/extrinsic/signedExtensions/types';
+import { OverrideBundleType, RegistryTypes } from '@polkadot/types/types';
 
 import { ChainProperties } from './codec';
 
@@ -38,4 +39,12 @@ export interface GetRegistryOptsCore {
  * User extensions used to inject into the type registry
  */
  userExtensions?: ExtDef;
+ /**
+ * OverrideTypesBundle to set to registry
+ */
+ typesBundle?: OverrideBundleType;
+ /**
+ * Additional types to register in the registry.
+ */
+ additionalTypes?: RegistryTypes;
 }

packages/txwrapper-dev/src/registries/mockGetRegistry.ts

@@ -1,6 +1,10 @@
 import { GenericChainProperties, TypeRegistry } from '@polkadot/types';
 import { ExtDef } from '@polkadot/types/extrinsic/signedExtensions/types';
-import { AnyJson, RegistryTypes } from '@polkadot/types/types';
+import {
+ AnyJson,
+ OverrideBundleType,
+ RegistryTypes,
+} from '@polkadot/types/types';
 
 import { mockCreateMetadata } from '../metadata';
 import { ChainProperties } from '../mock-types';
@@ -12,6 +16,8 @@ export interface MockGetRegistryBaseArgs {
  asCallsOnlyArg?: boolean;
  signedExtensions?: string[];
  userExtensions?: ExtDef;
+ typesBundle?: OverrideBundleType;
+ additionalTypes?: RegistryTypes;
 }
 
 export function mockGetRegistryBase({
@@ -21,6 +27,8 @@ export function mockGetRegistryBase({
  asCallsOnlyArg,
  signedExtensions,
  userExtensions,
+ typesBundle,
+ additionalTypes,
 }: MockGetRegistryBaseArgs): TypeRegistry {
  const registry = new TypeRegistry();
 
@@ -32,8 +40,14 @@ export function mockGetRegistryBase({
 
  registry.register(specTypes);
 
+ if (additionalTypes) {
+ registry.register(additionalTypes);
+ }
+
  registry.setMetadata(generatedMetadata, signedExtensions, userExtensions);
 
+ registry.setKnownTypes({ typesBundle });
+
  // Register the chain properties for this registry
  registry.setChainProperties(
  registry.createType(

packages/txwrapper-polkadot/src/index.ts

@@ -87,6 +87,8 @@ export function getRegistry({
  asCallsOnlyArg,
  signedExtensions,
  userExtensions,
+ typesBundle,
+ additionalTypes,
 }: GetRegistryOpts): TypeRegistry {
  // The default type registry has polkadot types
  const registry = new TypeRegistry();
@@ -107,5 +109,7 @@ export function getRegistry({
  asCallsOnlyArg,
  signedExtensions,
  userExtensions,
+ typesBundle,
+ additionalTypes,
  });
 }

packages/txwrapper-registry/src/index.ts

@@ -67,18 +67,18 @@ function parseTypesBundle(
  return parsedJson;
 }
 
-const typesBundle: OverrideBundleType | undefined = parseTypesBundle(
+const envTypesBundle: OverrideBundleType | undefined = parseTypesBundle(
  process.env.TX_TYPES_BUNDLE
 );
 
 /**
  * Create a registry with `knownTypes` via env variables.
  * ie: STX_TYPES_BUNDLE; STX_TYPES_CHAIN
  */
-export function createRegistry(): TypeRegistry {
+export function createRegistry(typesBundle?: OverrideBundleType): TypeRegistry {
  const registry = new TypeRegistry();
  registry.setKnownTypes({
- typesBundle: typesBundle,
+ typesBundle: typesBundle || envTypesBundle,
  });
 
  return registry;
@@ -97,6 +97,8 @@ export function getRegistry({
  metadataRpc,
  properties,
  asCallsOnlyArg,
+ typesBundle,
+ additionalTypes,
 }: GetRegistryOpts): TypeRegistry {
  const registry = createRegistry();
 
@@ -106,5 +108,7 @@ export function getRegistry({
  specTypes: getSpecTypes(registry, chainName, specName, specVersion),
  metadataRpc,
  asCallsOnlyArg,
+ typesBundle,
+ additionalTypes,
  });
 }