Refactor formatters to JSON schemas and TypeScript band-aid solution

[nazarhussain]

Description

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

Fixes #4778

Type of change

• New feature (non-breaking change which adds functionality)

Checklist:

• I have selected the correct base branch.
• I have performed a self-review of my own code.
• I have commented my code, particularly in hard-to-understand areas.
• I have made corresponding changes to the documentation.
• My changes generate no new warnings.
• Any dependent changes have been merged and published in downstream modules.
• I ran npm run dtslint with success and extended the tests and types if necessary.
• I ran npm run test:unit with success.
• I ran npm run test:cov and my test cases cover all the lines and branches of the added code.
• I ran npm run build and tested dist/web3.min.js in a browser.
• I have tested my code on the live network.
• I have checked the Deploy Preview and it looks correct.
• I have updated the CHANGELOG.md file in the root folder.

[spacesailor24]

I don't quite understand all that's going on in packages/web3-common/src/formatter.ts, but the use of the formatter seems better than what we had. Thank you Nazar

Only other feedback would be to pull any off the throw new Error('') into the respective errors.ts files

[nazarhussain]

@spacesailor24 We had two challenges to solve in formatters with schema.

1. To properly format the values
2. To properly transform the output type

The value transformation is done through schema provided. The type formation is done through the source type of the data you pass. I tried to format the types based on schema, but that was very complex and didn't cover a lot edge cases, so we had to transform type from the source type. e.g.

Say we have data:

const data = {
     prop: 2
};

const schema = {type: 'object', properties: {prop: {eth: 'uint'}}};

In above the schema tells that prop is an unsigned integer value, and formatter will format this value into any format based on FMT_NUMBER enum you pass. But second problem to solve here is the type of the object data. Currently type of object is {prop: number}, if we format it to FMT_NUMBER.HEX then we have to convert the type to {prop: string} as well.

So in this formatting technique the source data type is very important. Any type attribute which is declared as number | bigint will be type formatted as FMT_NUMBER and any type attribute which is declared as Buffer | Uint8Array will be formatted baed on FMT_BYTES.

So to make it work properly, even if you know an attribute is hex string bytes, don't declare the type as string or HexString, declare it as Buffer, the rest will be handled by FMT_BYTES enum you pass, similarly for FMT_NUMBER.