fix: address payable parsing (#275)

* add address payable solidity type parsing and tests

* test: add `payable address` case

* address payable type parsing fixed

* nits

* nits

* ci: apply automated fixes

* chore: tweaks

* chore: up

---------

Co-authored-by: Tom Meagher <tom@meagher.co>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: 3 people

package.json

@@ -11,7 +11,7 @@
     "check": "biome check --write",
     "check:repo": "sherif",
     "check:types": "pnpm run --r --parallel check:types && tsc --noEmit",
-    "check:types:propertyTypes": "pnpm run --r --parallel typecheck --exactOptionalPropertyTypes false && tsc --noEmit --exactOptionalPropertyTypes false",
+    "check:types:propertyTypes": "pnpm run --r --parallel check:types --exactOptionalPropertyTypes false && tsc --noEmit --exactOptionalPropertyTypes false",
     "check:unused": "pnpm clean && knip",
     "clean": "pnpm run --r --parallel clean && rm -rf packages/**/*.json.tmp",
     "deps": "pnpx taze -r",

packages/abitype/src/human-readable/runtime/utils.test.ts

@@ -56,6 +56,14 @@ test.each([
       stateMutability: 'view',
     },
   },
+  {
+    signature: 'function foo(address payable to) external',
+    expected: {
+      ...baseFunctionExpected,
+      inputs: [{ type: 'address', name: 'to' }],
+      stateMutability: 'nonpayable',
+    },
+  },
   {
     signature: 'function foo(string) public view returns (string)',
     expected: {

packages/abitype/src/human-readable/runtime/utils.ts

@@ -182,7 +182,7 @@ export function parseFallbackSignature(signature: string) {
 }
 
 const abiParameterWithoutTupleRegex =
-  /^(?<type>[a-zA-Z$_][a-zA-Z0-9$_]*)(?<array>(?:\[\d*?\])+?)?(?:\s(?<modifier>calldata|indexed|memory|storage{1}))?(?:\s(?<name>[a-zA-Z$_][a-zA-Z0-9$_]*))?$/
+  /^(?<type>[a-zA-Z$_][a-zA-Z0-9$_]*(?:\spayable)?)(?<array>(?:\[\d*?\])+?)?(?:\s(?<modifier>calldata|indexed|memory|storage{1}))?(?:\s(?<name>[a-zA-Z$_][a-zA-Z0-9$_]*))?$/
 const abiParameterWithTupleRegex =
   /^\((?<type>.+?)\)(?<array>(?:\[\d*?\])+?)?(?:\s(?<modifier>calldata|indexed|memory|storage{1}))?(?:\s(?<name>[a-zA-Z$_][a-zA-Z0-9$_]*))?$/
 const dynamicIntegerRegex = /^u?int$/
@@ -238,6 +238,8 @@ export function parseAbiParameter(param: string, options?: ParseOptions) {
     components = { components: structs[match.type] }
   } else if (dynamicIntegerRegex.test(match.type)) {
     type = `${match.type}256`
+  } else if (match.type === 'address payable') {
+    type = 'address'
   } else {
     type = match.type
     if (!(options?.type === 'struct') && !isSolidityType(type))

packages/abitype/src/human-readable/types/signatures.ts

@@ -113,10 +113,10 @@ export type Signatures<signatures extends readonly string[]> = {
   [key in keyof signatures]: Signature<signatures[key], key>
 }
 
-export type Modifier = 'calldata' | 'indexed' | 'memory' | 'storage'
+export type Modifier = 'calldata' | 'indexed' | 'memory' | 'payable' | 'storage'
 export type FunctionModifier = Extract<
   Modifier,
-  'calldata' | 'memory' | 'storage'
+  'calldata' | 'memory' | 'payable' | 'storage'
 >
 export type EventModifier = Extract<Modifier, 'indexed'>
 

packages/abitype/src/human-readable/types/utils.test-d.ts

@@ -209,6 +209,13 @@ test('ParseSignature', () => {
     inputs: [{ type: 'string' }],
     outputs: [],
   })
+  assertType<ParseSignature<'function foo(address payable to) external'>>({
+    name: 'foo',
+    type: 'function',
+    stateMutability: 'nonpayable',
+    inputs: [{ type: 'address', name: 'to' }],
+    outputs: [],
+  })
 
   assertType<ParseSignature<'function foo(string indexed)'>>({
     name: 'foo',