docs: configuration options

.changeset/grumpy-bobcats-tease.md

@@ -0,0 +1,5 @@
+---
+'abitype': patch
+---
+
+Expose configuration options

README.md

@@ -280,7 +280,9 @@ ABI canonical [types](https://docs.soliditylang.org/en/latest/abi-spec.html#json
 import { AbiType } from 'abitype'
 ```
 
-### Solidity
+### Solidity types
+
+[Solidity types](https://docs.soliditylang.org/en/latest/abi-spec.html#types) as template strings
 
 ```ts
 import {
@@ -296,6 +298,25 @@ import {
 } from 'abitype'
 ```
 
+## Configuration
+
+AbiType tries to strike a balance between type exhaustiveness and speed with sensible defaults. In some cases, you might want to tune your configuration (e.g. fixed array length). To do this, the following configuration options are available:
+
+```ts
+type FixedArrayLowerBound = 1
+type FixedArrayUpperBound = 5
+type Fixed2DArrayLowerBound = 1
+type Fixed2DArrayUpperBound = 5
+```
+
+To change a configuration option, use a module declaration:
+
+```ts
+declare module 'abitype/dist/config.d' {
+  type FixedArrayUpperBound = 10
+}
+```
+
 ## Support
 
 If you find AbiType useful, please consider supporting development. Thank you 🙏

src/abi.ts

@@ -1,4 +1,5 @@
 import { Range } from './types'
+import './config'
 
 export type Address = `0x${string}`
 
@@ -32,14 +33,6 @@ export type SolidityInt = `${'u' | ''}int${MBits}`
 //   | `${'u' | ''}fixed`
 //   | `${'u' | ''}fixed${MBits}x${Range<1, 20>[number]}`
 
-declare global {
-  type FixedArrayLowerBound = 1
-  type FixedArrayUpperBound = 5
-
-  type Fixed2DArrayLowerBound = 1
-  type Fixed2DArrayUpperBound = 5
-}
-
 export type SolidityFixedArrayRange = Range<
   FixedArrayLowerBound,
   FixedArrayUpperBound

src/config.ts

@@ -0,0 +1,9 @@
+declare global {
+  type FixedArrayLowerBound = 1
+  type FixedArrayUpperBound = 5
+
+  type Fixed2DArrayLowerBound = 1
+  type Fixed2DArrayUpperBound = 5
+}
+
+export {}