Client Generation

When you build a service, the CLI emits an abi.json describing its methods, types, and events. You can turn that ABI into a type-safe TypeScript client that other applications use to call your service.

The repository ships a helper, scripts/generate-client.js, which adapts the SDK’s ABI to the client generator’s format and runs @calimero-network/abi-codegen for you.

Pipeline

▶ Replay

1. Build your service

npx calimero-sdk build src/index.ts -o build/service.wasm

This creates build/abi.json next to build/service.wasm.

2. Generate the client

node scripts/generate-client.js <abi-json-path> <output-dir> [client-name]

Parameters

• <abi-json-path> — path to your ABI (default build/abi.json).
• <output-dir> — where generated files are written (default build/generated).
• [client-name] — optional class name for the generated client (passed through as --client-name).

Example

node scripts/generate-client.js build/abi.json src/generated CounterClient

Note

The helper strips the state_root field before invoking abi-codegen (which doesn’t accept it), writing a filtered ABI to a temp file. Your original abi.json is left untouched for runtime use. It shells out with npx, so @calimero-network/abi-codegen is fetched on demand.

There is also a thin shell wrapper, scripts/generate-client.sh, that forwards the same arguments.

3. Use the generated client

The generated file contains the client class plus the TypeScript types for your service. It talks to a node through the Calimero client library — roughly:

import { CounterClient } from './generated/CounterClient';
// ...construct/connect a client per your generator + client-library version...

const client = new CounterClient(/* app/context wiring */);

await client.increment();
const count = await client.getCount();

Note

The generator is the external @calimero-network/abi-codegen package, so the exact import path and the client’s constructor/connection shape depend on your installed generator and client-library version. Treat the snippet above as illustrative and follow the code your abi-codegen run emits.

Tip

Method names in the generated client follow the ABI exactly. If a call doesn’t resolve, inspect build/abi.json (or the generated .ts) to confirm the exported method name.

Wire it into your build

{
  "scripts": {
    "build": "calimero-sdk build src/index.ts -o build/service.wasm",
    "generate:client": "node scripts/generate-client.js build/abi.json src/generated",
    "build:all": "npm run build && npm run generate:client"
  }
}

Make sure the generated directory is included in your tsconfig.json include globs.

Troubleshooting

• “ABI file not found” — build the service first and check the path (ls build/abi.json).
• Client generation failed — verify abi.json is valid JSON and that npx can reach @calimero-network/abi-codegen; re-run with more output.
• Type errors in generated code — ensure a compatible @calimero-network/calimero-client version and that all service types are well-defined.