refactor: Streamline console.sol generation

[Xanewok]

• Because this PR includes a bug fix, relevant tests have been included.
• Because this PR includes a new feature, the change was previously discussed on an Issue or with someone from the team.
• I didn't do anything of this.

---

I'm working on porting console.log from Hardhat (NomicFoundation/edr#641). To better understand which exactly console.log functions we support and why, I refactored the build script for clarity in the process.

I separated helper logic (e.g. permutation generator) and upfront declare which functions we support:

• single parameter logUint, ..., logBytes32 and
• permutations of up to 4 of (uint256, string, bool, address), including empty log()

Since the calculation logic was mixed with rendering (and had to take into account duplicate signatures, for example), I disentangled it and streamlined the (data) flow. Hopefully this will be useful to anyone trying to understand this or modify in the future.

While making the changes, I also changed the function selectors in the logger.ts file to be a hexadecimal integer rather than a decimal one. This is the format everyone expects when working with it so there's no use in using decimals if a hexadecimal integer is natively supported as an object key.

In the future, we can remove the faulty (u)int ABI encoding; I tried to highlight and and document the backwards-compatibility here.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hardhat	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 18, 2024 5:06pm

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5b410f9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[Xanewok]

Suggested change

	[...Array(4)].flatMap((_, paramCount) => {
	return Array.from(
	genPermutations(TYPES.length, paramCount + 1),
	[...Array(5)].flatMap((_, paramCount) => {
	return Array.from(
	genPermutations(TYPES.length, paramCount),

As a side-note, this base case can handle generating the empty log() just fine but shifted its order in the console.sol file. This is probably meaningless but I wanted to avoid making any changes; let me know if you'd like me to not explicitly handle log() and handle this with this code, instead.

[fvictorio]

That's a good point, but yes, let's leave it as is.