fix: format abi item fallback formatting (#259)

* fix: format abi item fallback formatting * chore: tweaks * fix: type --------- Co-authored-by: Tom Meagher <tom@meagher.co>
wevm · Dec 3, 2024 · f417a23 · f417a23
1 parent ee60e67
commit f417a23
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 3 deletions.
diff --git a/.changeset/rich-turtles-film.md b/.changeset/rich-turtles-film.md
@@ -0,0 +1,5 @@
+---
+"abitype": patch
+---
+
+Fixed `formatAbiItem` fallback item formatting.
diff --git a/packages/abitype/src/human-readable/formatAbiItem.test-d.ts b/packages/abitype/src/human-readable/formatAbiItem.test-d.ts
@@ -105,4 +105,11 @@ test('formatAbiItem', () => {
     stateMutability: 'nonpayable',
   }
   expectTypeOf(formatAbiItem(abiItem)).toEqualTypeOf<string>()
+
+  expectTypeOf(
+    formatAbiItem({ type: 'fallback', stateMutability: 'nonpayable' }),
+  ).toEqualTypeOf<'fallback() external'>()
+  expectTypeOf(
+    formatAbiItem({ type: 'fallback', stateMutability: 'payable' }),
+  ).toEqualTypeOf<'fallback() external payable'>()
 })
diff --git a/packages/abitype/src/human-readable/formatAbiItem.test.ts b/packages/abitype/src/human-readable/formatAbiItem.test.ts
@@ -55,7 +55,14 @@ test.each([
       type: 'fallback',
       stateMutability: 'nonpayable',
     } as const,
-    expected: 'fallback()',
+    expected: 'fallback() external',
+  },
+  {
+    abiItem: {
+      type: 'fallback',
+      stateMutability: 'payable',
+    } as const,
+    expected: 'fallback() external payable',
   },
   {
     abiItem: {

diff --git a/packages/abitype/src/human-readable/formatAbiItem.ts b/packages/abitype/src/human-readable/formatAbiItem.ts
@@ -66,7 +66,9 @@ export type FormatAbiItem<abiItem extends Abi[number]> =
         | (abiItem extends AbiFallback
             ? AbiFallback extends abiItem
               ? string
-              : 'fallback()'
+              : `fallback() external${abiItem['stateMutability'] extends 'payable'
+                  ? ' payable'
+                  : ''}`
             : never)
         | (abiItem extends AbiReceive
             ? AbiReceive extends abiItem
@@ -126,6 +128,9 @@ export function formatAbiItem<const abiItem extends Abi[number]>(
     return `constructor(${formatAbiParameters(abiItem.inputs as Params)})${
       abiItem.stateMutability === 'payable' ? ' payable' : ''
     }`
-  if (abiItem.type === 'fallback') return 'fallback()' as Result
+  if (abiItem.type === 'fallback')
+    return `fallback() external${
+      abiItem.stateMutability === 'payable' ? ' payable' : ''
+    }` as Result
   return 'receive() external payable' as Result
 }