feat: add query param metadata

[TarikGul]

closes: #476

Pertains to /transaction/material

This adds the query param metadata that is acting as a replacement for the noMeta query param.

metadata will take in a format for what type of data you want back. It accepts 'json' or 'scale'.
json -> decoded metadata as json
scale -> SCALE encoded hex value of the metadata

noMeta will still be available for 2 more weekly releases then its subject to be removed. The currrent default behavior is that when there is no query param scale encoded metadata is returned. This will change when this is deprecated, and the default behavior will be no metadata unless the metadata field is specified.

[jsdw]

I was pondering whether this could be simplified. The best I came up with was:

if (!noMeta && metadata === 'json')
    return 'json';
if (!noMeta && metadata === 'scale')
    return 'scale';
if (!noMeta && metadata)
    throw new Error('Invalid inputted value for the `metadata` query param.');

if (noMeta) {
    Log.logger.warn(
        '`noMeta` query param will be deprecated in sidecar v13, and replaced with `metadata` please migrate'
    );
}
return false;

[TarikGul]

Yea I agree, when I wrote this I knew it was really late, and super messy looking and was in need of a re-write 😅 . Thank you for working through that, I had a lot of trouble grouping the arguments together. I agree the above is significantly better and ill update it!

[TarikGul]

So the only issue with the logic above is that we need to account for when no query params are inputted the default behavior is to have scale metadata returned.

/**
* Checks to see if the `metadata` query param is inputted, if it isnt,
* it will default to the old behavior. This is to be removed once after 
* the `noMeta` query param is fully deprecated.
*/
if (metadata) {
    switch (metadata) {
        case('json'):
            return 'json';
        case('scale'):
            return 'scale';
        default:
            throw new Error('Invalid inputted value for the `metadata` query param.');
    }
}

if (noMeta) {
    Log.logger.warn(
        '`noMeta` query param will be deprecated in sidecar v13, and replaced with `metadata` please migrate'
    );
    switch (noMeta) {
        case('true'):
            return false;
        case('false'):
            return 'scale';
    }
}

// default behavior until `noMeta` is deprecated, then false will be default
return 'scale';

[TarikGul]

So i updated the logic a little, and kept the same format :). Thanks for making this easy for me to understand!

[TarikGul]

Also the idea here being that we want the metadata query param to override noMeta if its used

[jsdw]

Aaah overriding noMeta, got it! your new version looks clean :)