[Bug] getSchema returns a schema name that contains the dynamic part for MappingWithGrouping

[CJ42]

I'm submitting a...

bug report

Summary

When using the function getSchema with data keys that are of type MappingWithGrouping, the schema returned contains the dynamic part like <address> in the example below.

This creates an issue as when comparing, or running tests (screenshots below), as it should return either:

• AddressPermissions:Permissions or
• AddressPermissions:Permissions:<address>

Other information (e.g. detailed explanation, stack traces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

The issue comes from the internal logic of the function that parse schemas. They append the :{address} at the end (line 134 below)

erc725.js/src/lib/schemaParser.ts

Lines 116 to 136 in 8b1d1ff

	const findMappingWithGroupingSchemaForKey = (
	key: string,
	schemas: ERC725JSONSchema[],
	): ERC725JSONSchema | null => {
	const keySchema =
	schemas.find(
	(schema) => schema.key.substring(0, 26) === key.substring(0, 26),
	) || null;
	const address = key.substring(26);
	if (keySchema) {
	return {
	...keySchema,
	key,
	name: `${keySchema.name.substring(
	0,
	keySchema.name.lastIndexOf(':'),
	)}:${address}`,
	};
	}

Proposal

• [] Return the exact same schema name containing even <address> (the dynamic part).
• [] Add in the object returned an entry dynamicKeyPart that contains the dynamic key
• [] Create a new developer friendly function called getHumanReadableKey (something like this) that would return the first part of the data key as words + the dynamic part, like in the screenshot above. For instance

ERC725.getHumanReadableKey('0x4b80742de2bf82acb3630000ea08aa95d02df6146bb999572e9ebd261a798ef6')
// returns: "AddressPermissions:Permissions:ea08aa95d02df6146bb999572e9ebd261a798ef6"

[CJ42]

Closing as completed in #428