autoload: Add abiFillEmptyNames helper

[yohamta]

This PR addresses #148

Changes overview:

• Added the abiFillEmptyNames helper function and necessary types
• Added the abiHelpers option to the AutoloadConfig

[shazow]

Overall looks good, just a couple nits/questions. The main thing is I think I'd prefer to put this in abi.ts rather than make a helpers.ts, let me know what you think!

[shazow]

Should probably refer to them as "parameter" rather than "field? per https://docs.soliditylang.org/en/latest/abi-spec.html

Is there a convention to hint that it's not an official name? Underscore-prefix or something?

I liked your original idea of just doing _{index} because it "looks" more generative, but I could be convinced for something else.

[yohamta]

How about _p{index}? We initially tried _{index}, but geth requires at least one alphabetical character.

[shazow]

Ah. How about _param{index} then?

[yohamta]

I’ve updated it to _p{index} with commit add0386

[yohamta]

Oh sorry, I missed the comment. Updated it to _param{index}: 1b24265

[shoenseiwaso]

@shazow @yohamta I think param is okay, but if we're going by the ABI spec that shazow shared above, wouldn't it be component for tuples and not parameter?

[shazow]

I'm just going by this:

name: the name of the parameter.

[yohamta]

Yes, you're right. Since we're dealing with components, using _comp{index} might make sense too, I think.

[shazow]

This still doesn't feel great to me, because the code difference is...

const result = whatsabi.autoload(address, { provider, abiHelpers: [whatsabi.abi.abiFillEmptyNames] })
result.abi // use it

vs

const result = whatsabi.autoload(address, { provider })
whatsabi.abi.abiFillEmptyNames(result.abi) // use it

Which doesn't feel like it warrants putting it into autoload?

Also now I'm thinking maybe it should be whatsabi.abi.fillEmptyNames, but I can update that later.

By the way, are you using enableExperimentalMetadata?

[yohamta]

Sure, let's remove it from autoload for now: 32be43b

I also renamed the function: 2ba3e9e

We're using enableExperimentalMetadata, though we’re not entirely sure if it's necessary at this point.

[shazow]

I'd feel more comfortable making it default under the enableExperimentalMetadata flag, since I don't think many people use it so it won't be very breaking (plus it is experimental).

Also I think WhatsABI would only generate types with empty names with that flag enabled? Or I might be mistaken.

[shazow]

Appreciate the changes. No need to make further changes, just brainstorming at the moment. :)

[yohamta]

Thanks for the great review! I just pushed a small fix in the comment part: 6f618fc

[shazow]

Thanks for the PR and rapid iterations. :)

I'll take a closer look tomorrow and merge this.