diff --git a/.trix/client-lib/README.md.hbs b/.trix/client-lib/README.md.hbs new file mode 100644 index 0000000..2082b95 --- /dev/null +++ b/.trix/client-lib/README.md.hbs @@ -0,0 +1,27 @@ +# {{tii.protocol.name}} — Python 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`: + +```sh +pip install tx3-sdk +``` + +If you also need a local dev runtime, `trix devnet` exposes a TRP endpoint at `http://localhost:8164`. + +## Use the client + +```python +from tx3_sdk import ClientOptions, Party +from {{tii.protocol.name}} import Client, Profile + +client = Client( + ClientOptions(endpoint="http://localhost:8164"), + Profile.LOCAL, +) +``` + +Each `tx` declared by the protocol becomes a typed method on `client`, returning the `resolve → sign → submit → wait` lifecycle. See the [Tx3 consuming guide](https://docs.txpipe.io/tx3/consuming/quick-start) for the full walkthrough.