Skip to content

Add README.md.hbs to client-lib templates #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
scarmuega merged 1 commit into from
May 29, 2026
Merged

Add README.md.hbs to client-lib templates #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .trix/client-lib/README.md.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# {{tii.protocol.name}} — TypeScript client

Generated by `trix codegen` from the `{{tii.protocol.name}}@{{tii.protocol.version}}` protocol interface. Do not edit by hand — re-run `trix codegen` to refresh.

## Install the runtime SDK

The generated client delegates transport, signing, and lifecycle to `tx3-sdk`. From the directory that *consumes* this client (not from inside this folder):

```sh
npm install tx3-sdk
```

If you also need a local dev runtime, `trix devnet` exposes a TRP endpoint at `http://localhost:8164`.

## Use the client

```ts
import { Client } from "./{{tii.protocol.name}}";
import { Party, Ed25519Signer } from "tx3-sdk";

const client = new Client(
{ endpoint: "http://localhost:8164" },
"local",
);
```

Each `tx` declared by the protocol becomes a typed method on `client`, returning the four-stage `resolve → sign → submit → wait` lifecycle. See the [Tx3 consuming guide](https://docs.txpipe.io/tx3/consuming/quick-start) for the full walkthrough.
Loading