feat: generate TypeScript ABI files for improved type inference

Author: nowooj

contracts/README.md

@@ -23,7 +23,7 @@ After installation, use the following paths:
 | Path | Description |
 |------|-------------|
 | `cosmos-evm-contracts/precompiles/` | Solidity sources (`.sol`) |
-| `cosmos-evm-contracts/abi/precompiles/` | ABI-only JSON (`.json`) |
+| `cosmos-evm-contracts/abi/precompiles/` | ABI as JSON (`.json`) or typed ESM (`.js` + `.d.ts`) |
 
 Included precompiles: `bank`, `bech32`, `callbacks`, `common`, `distribution`, `erc20`, `gov`, `ics02`, `ics20`, `slashing`, `staking`, `werc20` (testdata and testutil excluded).
 
@@ -38,6 +38,27 @@ import IBankAbi from "cosmos-evm-contracts/abi/precompiles/bank/IBank.json" asse
 const IBankAbi = require("cosmos-evm-contracts/abi/precompiles/bank/IBank.json");
 ```
 
+### Loading ABI with TypeScript / viem (typed)
+
+Import the named ABI constant so that `functionName`, `args`, and return types are inferred:
+
+```typescript
+import { createPublicClient, http } from "viem";
+import { IBank_ABI } from "cosmos-evm-contracts/abi/precompiles/bank/IBank";
+
+const client = createPublicClient({ transport: http() });
+
+// functionName and args are type-checked and autocompleted
+const balances = await client.readContract({
+  address: "0x0000000000000000000000000000000000000804",
+  abi: IBank_ABI,
+  functionName: "balances",
+  args: ["0x..."],
+});
+```
+
+Use the same pattern for other precompiles, e.g. `DistributionI_ABI` from `abi/precompiles/distribution/DistributionI`, `StakingI_ABI` from `abi/precompiles/staking/StakingI`, etc.
+
 ### Using interfaces in Hardhat
 
 Import by package path in your contract:

contracts/package.json

@@ -1,14 +1,15 @@
 {
   "name": "cosmos-evm-contracts",
   "packageManager": "pnpm@9.15.0",
-  "version": "0.0.1",
+  "version": "0.0.6",
   "description": "A collection of smart contracts used in the development of the Cosmos EVM blockchain.",
   "devDependencies": {
     "@openzeppelin/contracts": "^5.4.0",
-    "hardhat": "^3.1.10"
+    "hardhat": "^3.1.10",
+    "typescript": "^5.0.0"
   },
   "scripts": {
-    "build:precompiles": "node scripts/build-precompiles.js",
+    "build:precompiles": "node scripts/build-precompiles.js && pnpm exec tsc -p tsconfig.json",
     "compile": "hardhat compile",
     "prepublishOnly": "pnpm run build:precompiles"
   },

contracts/pnpm-lock.yaml

@@ -2,7 +2,7 @@
 /**
  * Build precompile contracts (excluding testdata, testutil) in OpenZeppelin style:
  * - dist/precompiles/ : .sol sources
- * - dist/abi/         : ABI-only JSON per contract
+ * - dist/abi/         : ABI-only JSON + .ts (as const); tsc emits .js + .d.ts
  *
  * Run from contracts directory: pnpm run build:precompiles
  */
@@ -80,14 +80,22 @@ function buildPrecompiles() {
     if (!sourceName || !sourceName.startsWith("solidity/precompiles/")) continue;
 
     const relFromSolidity = sourceName.replace(/^solidity\//, ""); // precompiles/bank/IBank.sol
+    const contractName = relFromSolidity.replace(/\.sol$/, "").split("/").pop(); // e.g. IBank
     const solPath = join(SOLIDITY_SOURCE, relFromSolidity);
     const abiOutPath = join(DIST_ABI, relFromSolidity.replace(".sol", ".json"));
+    const abiTsOutPath = join(DIST_ABI, relFromSolidity.replace(".sol", ".ts"));
     const solOutPath = join(DIST, relFromSolidity);
 
     ensureDir(dirname(abiOutPath));
     ensureDir(dirname(solOutPath));
 
-    writeFileSync(abiOutPath, JSON.stringify(artifact.abi ?? [], null, 2), "utf8");
+    const abi = artifact.abi ?? [];
+    writeFileSync(abiOutPath, JSON.stringify(abi, null, 2), "utf8");
+    writeFileSync(
+      abiTsOutPath,
+      `export const ${contractName}_ABI = ${JSON.stringify(abi, null, 2)} as const;\n`,
+      "utf8"
+    );
     if (existsSync(solPath)) {
       cpSync(solPath, solOutPath);
       copiedSol.add(relFromSolidity);

contracts/scripts/build-precompiles.js

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "declaration": true,
+    "rootDir": "dist/abi",
+    "outDir": "dist/abi",
+    "skipLibCheck": true,
+    "strict": true
+  },
+  "include": ["dist/abi/**/*.ts"],
+  "exclude": []
+}