@riaskov/iohtee-abi-wrapper 3.0.1 → 3.0.3

package/README.md

@@ -21,6 +21,60 @@ Or global:
 pnpm add -g @riaskov/iohtee-abi-wrapper
 ```
 
+## Tutorial: Solidity -> JSON ABI (Hardhat 3)
+
+### 1. Create Hardhat 3 project
+
+```bash
+mkdir my-contracts && cd my-contracts
+pnpm init
+pnpm add -D hardhat typescript tsx
+pnpm hardhat --init
+```
+
+Put your contract in `contracts/`, for example `contracts/Unidirectional.sol`.
+
+### 2. Compile contracts
+
+```bash
+pnpm hardhat compile
+```
+
+Hardhat writes artifacts to:
+
+`artifacts/contracts/<FileName>.sol/<ContractName>.json`
+
+Example:
+
+`artifacts/contracts/Unidirectional.sol/Unidirectional.json`
+
+### 3. Extract ABI JSON
+
+Hardhat artifact already contains `abi` field:
+
+```json
+{
+  "abi": [ ... ]
+}
+```
+
+You can pass this artifact directly to `iohtee-abi-wrapper`.
+
+
+### 4. Generate wrappers
+
+From artifact:
+
+```bash
+iohtee-abi-wrapper -o ./generated -b viem artifacts/contracts/Unidirectional.sol/Unidirectional.json
+```
+
+From pure ABI folder:
+
+```bash
+iohtee-abi-wrapper -o ./generated -b viem ./abi
+```
+
 ## CLI usage
 
 ```bash
@@ -71,3 +125,80 @@ pnpm --filter @riaskov/iohtee-abi-wrapper run build
 ## Output
 
 For `Unidirectional.json`, generator emits `UnidirectionalContract` wrapper and typings.
+
+## Usage examples
+
+### Unidirectional + viem backend
+
+```ts
+// generated with:
+// iohtee-abi-wrapper -o ./generated-viem -b viem ./abi/Unidirectional.json
+import {
+  UnidirectionalContract,
+  UnidirectionalEventName,
+} from './generated-viem/UnidirectionalContract.js'
+
+const contract = new UnidirectionalContract(
+  '0x1111111111111111111111111111111111111111',
+  {
+    httpRpcUrl: 'http://127.0.0.1:8545',
+    networkId: 31337,
+    mnemonic: 'test test test test test test test test test test test junk',
+    hdPath: "m/44'/60'/0'/0/0",
+  },
+)
+
+const channelId =
+  '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
+
+// view call
+const canDeposit = await contract.canDeposit(
+  channelId,
+  '0x2222222222222222222222222222222222222222',
+)
+console.log('canDeposit:', canDeposit)
+
+// state-changing call
+const receipt = await contract.deposit(channelId, { value: 1_000_000_000_000n })
+const hasDepositEvent = UnidirectionalContract.hasEvent(
+  receipt,
+  UnidirectionalEventName.DidDeposit,
+)
+console.log('DidDeposit emitted:', hasDepositEvent)
+```
+
+### Unidirectional + ethers backend
+
+```ts
+// generated with:
+// iohtee-abi-wrapper -o ./generated-ethers -b ethers ./abi/Unidirectional.json
+import {
+  UnidirectionalContract,
+  UnidirectionalEventName,
+} from './generated-ethers/UnidirectionalContract.js'
+
+const contract = new UnidirectionalContract(
+  '0x1111111111111111111111111111111111111111',
+  {
+    httpRpcUrl: 'http://127.0.0.1:8545',
+    networkId: 31337,
+    mnemonic: 'test test test test test test test test test test test junk',
+    hdPath: "m/44'/60'/0'/0/0",
+  },
+)
+
+const channelId =
+  '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
+
+// view call
+const digest = await contract.paymentDigest(channelId, 10n)
+console.log('paymentDigest:', digest)
+
+// state-changing call
+const receipt = await contract.deposit(channelId, { value: 1_000_000_000_000n })
+const hasDepositEvent = UnidirectionalContract.hasEvent(
+  receipt,
+  UnidirectionalEventName.DidDeposit,
+)
+console.log('DidDeposit emitted:', hasDepositEvent)
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riaskov/iohtee-abi-wrapper",
-  "version": "3.0.1",
+  "version": "3.0.3",
   "description": "Generate TypeScript wrapper class for Solidity smart contract ABI",
   "license": "Apache-2.0",
   "author": "Machinomy Team <hello@machinomy.com>",
@@ -36,6 +36,14 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": "dist/bin/iohtee-abi-wrapper.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
   "files": [
     "dist/",
     "templates/"

package/templates/contract.ethers.eta

@@ -1,3 +1,5 @@
+/* eslint-disable */
+/* tslint:disable */
 import { Interface, TransactionReceipt, type InterfaceAbi } from 'ethers'
 import {
   BaseContractEthers,

package/templates/contract.viem.eta

@@ -1,3 +1,5 @@
+/* eslint-disable */
+/* tslint:disable */
 import {
   TransactionReceipt,
   parseEventLogs,