Document examples for encoding/decoding CompactBytesArray

[CJ42]

I'm submitting a...

• bug report
• feature request
• question about the decisions made in the repository
• question about how to use this project
• documentation request

Summary

There is no documentation on erc725.js about the fact that the library can encode/decode CompactBytesArray.

There should be some examples in the documentation where we show how CompactBytesArray are encoded/decoded, especially the ouput if it's a normal valueType (an array of valueTypes), or a tuple (a 2D array of valueTypes).

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 only place where we can find some infos are the tests files at the moment:

-> https://github.com/ERC725Alliance/erc725.js/blob/develop/src/lib/encoder.test.ts#L153-L157
-> https://github.com/ERC725Alliance/erc725.js/blob/develop/src/lib/utils.test.ts#L140

[Hugoo]

Could be nice to make an example of:

• LSP18 Royalties lukso-network/LIPs#141

[CJ42]

Could be nice to make an example of:

• LSP18 Royalties lukso-network/LIPs#141

Test should be:

{
        schema: {
          name: 'LSP18RoyaltiesRecipients',
          key: '0xc0569ca6c9180acc2c3590f36330a36ae19015a19f4e85c28a7631e3317e6b9d',
          keyType: 'Singleton',
          valueType: '(bytes4,address,uint32)[CompactBytesArray]',
          valueContent: '(Bytes4,Address,Number)',
        },
        decodedValue: [
          [
            '0x3e89ad98', // LSP0 interface ID
            '0xCA41e4ea94c8fA99889c8EA2c8948768cBaf4bc0', // recipient address (checksummed)
            15000, // royalty percentage in points (100 % = 100_000). Here 15_000 for 15 % = 0x00003a98 as bytes4 hex
          ],
          [
            '0xffffffff', // any standard interface ID
            '0xF70Ce3b58f275A4c28d06C98615760dDe774DE57',
            10000, // 10_000 (for 10 %) = 0x00002710 as bytes4 hex
          ],
          [
            '0xffffffff', // any standard interface ID
            '0xd3236aa1B8A4dDe5eA375fd1F2Fb5c354e686c9f',
            8000, // 8_000 (for 8 %) = 0x00001f40 as bytes4 hex
          ],
        ],
        encodedValue:
          '0x001c3e89ad98ca41e4ea94c8fa99889c8ea2c8948768cbaf4bc000003a98001cfffffffff70ce3b58f275a4c28d06c98615760dde774de5700002710001cffffffffd3236aa1b8a4dde5ea375fd1f2fb5c354e686c9f00001f40',
      },

[CJ42]

This issue can be closed once we have an example with LSP18Royalties.