![\"abi-typegen\"](\"https://raw.githubusercontent.com/doublesharp/abi-typegen/main/docs/abi-typegen.png\")
\n\n \n
Fast typed bindings from Solidity ABI artifacts.
\nHardhat plugin · auto-generate on compile · ~30x faster than TypeChain
\n\n# @0xdoublesharp/hardhat-abi-typegen\n\nHardhat plugin for [abi-typegen](https://github.com/doublesharp/abi-typegen). Generates typed bindings from Solidity ABI artifacts on every `hardhat compile`. Downloads the pre-built `abi-typegen` binary for your platform automatically.\n\n## Install\n\n```sh\nnpm install -D @0xdoublesharp/hardhat-abi-typegen\nyarn add -D @0xdoublesharp/hardhat-abi-typegen\npnpm add -D @0xdoublesharp/hardhat-abi-typegen\n```\n\n## Setup\n\n### Hardhat 3\n\nAdd the plugin to `plugins` in `hardhat.config.ts`:\n\n```typescript\nimport { defineConfig } from \"hardhat/config\";\nimport abiTypegen from \"@0xdoublesharp/hardhat-abi-typegen\";\n\nexport default defineConfig({\n plugins: [abiTypegen],\n solidity: \"0.8.34\",\n typegen: {\n out: \"src/generated\", // output directory (default: \"src/generated\")\n target: \"viem\", // target name or comma-separated targets\n wrappers: true, // emit typed wrappers (default: true)\n contracts: [\"Token\"], // optional - limit to named contracts\n exclude: [\"*Test\", \"*Mock\"], // optional - exclude by glob pattern\n },\n});\n```\n\n### Hardhat 2\n\nHardhat 2 projects can keep the side-effect import:\n\n```typescript\nimport \"@0xdoublesharp/hardhat-abi-typegen\";\n\nconst config: HardhatUserConfig = {\n solidity: \"0.8.34\",\n typegen: {\n out: \"src/generated\", // output directory (default: \"src/generated\")\n target: \"viem\", // target name or comma-separated targets\n wrappers: true, // emit typed wrappers (default: true)\n contracts: [\"Token\"], // optional - limit to named contracts\n exclude: [\"*Test\", \"*Mock\"], // optional - exclude by glob pattern\n },\n};\n\nexport default config;\n```\n\nThe package uses conditional exports: ESM imports get the Hardhat 3 plugin object, and CommonJS/Hardhat 2 imports get the legacy task-hook plugin. The explicit fallback subpath `@0xdoublesharp/hardhat-abi-typegen/hardhat2` is also available for Hardhat 2 projects that want to pin the legacy adapter.\n\n## Usage\n\nTypes are generated automatically after every compile:\n\n```sh\nnpx hardhat compile\n# → abi-typegen: generated 5 contract(s) → src/generated\n```\n\nOr generate directly:\n\n```sh\nnpx abi-typegen generate --hardhat --target viem\n```\n\n## Configuration\n\n| Option | Type | Default | Description |\n| ----------- | -------------------- | ----------------- | --------------------------------------------------------------------- |\n| `out` | `string` | `\"src/generated\"` | Output directory for generated files |\n| `target` | `string \\| string[]` | `\"viem\"` | Target name, comma-separated targets, or array of targets (see below) |\n| `wrappers` | `boolean` | `true` | Emit typed wrapper files when supported |\n| `contracts` | `string[]` | `[]` | Limit to named contracts (empty = all) |\n| `exclude` | `string[]` | `[]` | Exclude contracts matching glob patterns |\n\n## Targets\n\nThere are 28 CLI targets across 21 languages. Unity uses the `csharp` target\nwith an adapter package.\n\n### JavaScript and TypeScript\n\n| Target | Framework or SDK | What you get |\n| --------- | ---------------------------------------- | ------------------------------------------------ |\n| `viem` | [viem](https://viem.sh/) | Typed contract helpers and ABI |\n| `wagmi` | [wagmi](https://wagmi.sh/) | React hooks for reads, writes, and events |\n| `ethers` | [ethers v6](https://docs.ethers.org/v6/) | Typed contract interfaces and connection helpers |\n| `ethers5` | [ethers v5](https://docs.ethers.org/v5/) | Typed contract interfaces and connection helpers |\n| `web3js` | [web3.js v4](https://docs.web3js.org/) | Typed contract methods |\n| `zod` | [Zod 4](https://zod.dev/) | Validation schemas and ABI |\n\n### Native languages\n\n| Language | Target | Runtime or SDK | What you get |\n| -------- | -------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |\n| C | `c` | [Shared Rust runtime](https://github.com/doublesharp/abi-typegen/blob/main/docs/native-bindings.md#c-and-c) | C11 codecs and client helpers with explicit ownership |\n| C++ | `cpp` | [Shared Rust runtime](https://github.com/doublesharp/abi-typegen/blob/main/docs/native-bindings.md#c-and-c) | C++17 codecs and client helpers with automatic cleanup |\n| C# | `csharp` | [Nethereum](https://docs.nethereum.com/) | Typed DTOs, contract methods, and deployment |\n| Dart | `dart` | [web3dart](https://pub.dev/packages/web3dart) | Typed values, codecs, calls, and transactions |\n| Elixir | `elixir` | [Ethers](https://ethers.hexdocs.pm/Ethers.html) | Transaction data, reads, sends, events, and errors |\n| F# | `fsharp` | [Nethereum](https://docs.nethereum.com/) | Records, ABI codecs, and contract helpers |\n| Go | `go` | [go-ethereum](https://geth.ethereum.org/docs/developers) | Typed calls, transactions, deployment, and events |\n| Java | `java` | [web3j](https://docs.web3j.io/latest/) | Typed values, codecs, calls, and transactions |\n| Kotlin | `kotlin` | [web3j](https://docs.web3j.io/latest/) | Typed values, codecs, calls, and transactions |\n| OCaml | `ocaml` | [Zarith](https://github.com/ocaml/Zarith) and shared Rust runtime | Records, ABI codecs, and caller-supplied transport |\n| PHP | `php` | [Brick Math](https://github.com/brick/math), [ethereum-tx](https://github.com/web3p/ethereum-tx), cURL | Codecs, RPC reads, signed legacy transactions, receipts, and logs |\n| Python | `python` | [web3.py](https://web3py.readthedocs.io/en/stable/) | Reads, transaction builders, codecs, events, and errors |\n| q | `q` | [kdb+](https://code.kx.com/q/) and shared Rust runtime | Event table schemas, decoders, and log rows |\n| Ruby | `ruby` | [eth](https://github.com/q9f/eth.rb) | Calls, transaction builders, codecs, events, and errors |\n| Rust | `rust` | [Alloy](https://alloy.rs/introduction/getting-started/) | `sol!` types, codecs, and contract instances |\n| Swift | `swift` | [web3swift](https://github.com/web3swift-team/web3swift) | Typed values, codecs, and contract operations |\n\n### Game engines\n\n| Engine | Target | What you get |\n| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |\n| [Unity](https://docs.unity3d.com/Manual/index.html) | `csharp` + [Unity adapter](https://github.com/doublesharp/abi-typegen/tree/main/integrations/unity/com.doublesharp.abi-typegen.unity/) | C# bindings with Unity HTTP transport and object lifecycle support |\n| [Godot](https://docs.godotengine.org/en/stable/) | `godot` | GDScript bindings and a native extension for codecs and asynchronous RPC |\n| [Unreal Engine](https://dev.epicgames.com/documentation/en-us/unreal-engine/) | `unreal` | C++ codecs and Blueprint nodes for asynchronous scalar reads |\n\nSee [engine packages](https://github.com/doublesharp/abi-typegen/blob/main/integrations/README.md) for setup and\n[native bindings](https://github.com/doublesharp/abi-typegen/blob/main/docs/native-bindings.md) for supported features and platforms.\n\n### Shell and ABI formats\n\n| Target | Works with | What you get |\n| ---------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |\n| `shell` | [Bash](https://www.gnu.org/software/bash/manual/bash.html) and [Foundry cast](https://www.getfoundry.sh/cast) | Sourceable helpers for encoding, reads, sends, deployment, and logs |\n| `solidity` | [Solidity](https://docs.soliditylang.org/en/latest/) | Interfaces, tuple structs, events, and errors |\n| `yaml` | [YAML](https://yaml.org/) | Readable ABI descriptions |\n\nZod, Solidity, and YAML describe or validate contracts; they do not submit\ntransactions. See [native bindings](https://github.com/doublesharp/abi-typegen/blob/main/docs/native-bindings.md) for SDK versions\nand [configuration](https://github.com/doublesharp/abi-typegen/blob/main/docs/configuration.md) for target aliases.\n\n### COBOL\n\n| Target | Works with | What you get |\n| ------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------- |\n| `cobol` | [GnuCOBOL](https://gnucobol.sourceforge.io/doc/gnucobol.html) and the shared Rust runtime | Reads taking one address and returning one uint256 🤷 |\n\nTarget aliases: `ethers6` → ethers, `web3` → web3js, `cs` → csharp, `kt` → kotlin, `sol` → solidity, `yml` → yaml, `c++` → cpp, `fs`/`f#` → fsharp, `ml` → ocaml, `kdb`/`kdb+` → q\n\nMulti-target examples — each target gets its own output subdirectory:\n\n```typescript\ntarget: \"viem,python,rust\"; // comma-separated string\ntarget: [\"viem\", \"python\", \"rust\"]; // array of strings\n```\n\n## Notes\n\n- When using `target: \"zod\"`, install the latest `zod` package in the consuming project\n- Use comma-separated multi-target generation instead of the removed `all` and `all-ts` aliases\n\nSee [github.com/doublesharp/abi-typegen](https://github.com/doublesharp/abi-typegen) for full documentation.\n\n## Native contract bindings\n\nGo, Swift, Kotlin, C#, F#, Java, and Dart wrappers use their runtime SDKs for contract\ncalls and transactions. PHP includes ABI codecs, JSON-RPC reads, legacy transaction\nsigning, receipt and log queries, and event/error decoding. It requires PHP 8.2+ with\ncURL, GMP, mbstring, and iconv. It does not generate EIP-1559 or deployment helpers. C/C++ bindings link `abi-typegen-runtime` and accept a\ncaller-supplied transport/signing adapter. OCaml uses Zarith integers and the\nshared runtime with application-supplied transport. q/kdb+ generates event schemas,\ndecoders, and log rows; it does not include an RPC client. OCaml and q also require\ncompiled bridges linked to the shared runtime. `--no-wrappers` preserves primary\nABI metadata, value types, and q table schemas. See the [native binding guide](https://github.com/doublesharp/abi-typegen/blob/main/docs/native-bindings.md)\nfor dependencies, ownership rules, supported features, and SDK limits.\n","readmeFilename":"README.md"}