feat: signature from ABI item

[SebastienGllmt]

Goal

Solidity allows overloading functions & events - that is to say, you can for example have multiple events with the same name. To avoid this being an issue, Solidity converts ABI entries to a signature which is then used to generate a "selector" (a part of the hash of the signature)

Generating this signature with a static type is important for downstream libraries like viem because the current lack of this feature means viem can't differentiate between events/functions with the same name leading to subtle bugs and bypassing this limitation requires dropping type safety in viem.

Open questions

1. I added the code to generate the signature from an ABI entry, but I didn't create the inverse (a parse). This is because signatures are lossy so you can't really compute the inverse anyway (but maybe somebody would benefit from even a partial inverse)
2. I added this to the human-readable folder since it felt like the closest place to add it, but this code doesn't fit particularly well in any of the existing folders I feel. Open to thoughts on this

Test

 ✓ src/human-readable/signatureAbiItem.bench.ts (6) 5781ms

   ✓ Generate Function ABI signature (3) 2856ms
     · abitype   3,859,297.54 ops/sec ±1.31% (1929649 samples) fastest
     · ethers@6     47,912.60 ops/sec ±0.61% (  23957 samples) slowest
     · ethers@5    136,142.23 ops/sec ±0.69% (  68072 samples)

   ✓ Generate Event ABI signature (3) 2923ms
     · abitype   3,849,295.03 ops/sec ±1.51% (1924648 samples) fastest
     · ethers@6     77,291.49 ops/sec ±0.75% (  38646 samples) slowest
     · ethers@5    208,198.71 ops/sec ±0.80% ( 104100 samples)

Test

✓ src/signature/signatureAbiItem.test.ts (8)
   ✓ signatureAbiItem: function
   ✓ signatureAbiItem: function
   ✓ signatureAbiItem: function
   ✓ signatureAbiItem: function
   ✓ signatureAbiItem: event
   ✓ signatureAbiItem: event
   ✓ signatureAbiItem: event
   ✓ signatureAbiItem: event

Type test

✓ src/signature/signatureAbiItem.test-d.ts (2)
   ✓ SelectorAbiItem: function
   ✓ SelectorAbiItem: event

---

PR-Codex overview

This PR introduces the signatureAbiItem function for formatting ABI items into their corresponding signatures, enhancing ABI handling in the library. It also includes tests and benchmarks for performance comparison with the ethers library.

Detailed summary

• Added signatureAbiItem function to format ABI items.
• Exported signatureAbiItem
• Updated documentation with details on signatureAbiItem.
• Added benchmarks comparing signatureAbiItem with ethers library.
• Created tests for SignatureAbiItem type and its functionality.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

[changeset-bot]

🦋 Changeset detected

Latest commit: 88b76ec

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
abitype	Minor

Not sure what this means? Click here to learn what changesets are.

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

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
abitype	❌ Failed (Inspect)			Oct 24, 2024 6:46pm