Skip to content

Commit 1c72b10

Browse files
committed
Add list of clients to documentation
As MeshJS has now official support for a Hydra provider, keeping a list of clients that are using the API is long overdue. This will help users to discover tools, but also be useful to notify / update clients in case we need to break the client API.
1 parent 0057a59 commit 1c72b10

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ changes.
3838
- Remove `GetUTxO` client input and corresponding `GetUTxOResponse`. There is already a way to query the `UTxO` in the Head with `GET /snapshot/utxo` query.
3939
- Renamed 'CommitFinalized' field 'theDeposit' to 'depositTxId'.
4040

41+
- Add a list of [clients](https://hydra.family/head-protocol/unstable/docs/clients) to the docs
42+
4143
## [0.20.0] - 2025-02-04
4244

4345
- **BETA** hydra-node now supports incremental commits in beta mode. We would like to test out this feature

docs/docs/clients.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Clients
3+
---
4+
5+
# Clients
6+
7+
While the `hydra-node` tracks the main chain for opening/closing heads and connects to other nodes to form an overlay network, it also offers a [client API](/api-reference) to _use_ and _administrate_ the Hydra head. This API can be used directly by applications integrating with Hydra through SDKs, or via third-party components.
8+
9+
## Client applications
10+
11+
- [hydra-tui](https://hydra.family/head-protocol/docs/getting-started#use-the-head): Example client offering a terminal user interface (TUI) that can be used to adminstrate heads and submit simple payment transactions
12+
- [kupo](https://cardanosolutions.github.io/kupo/#section/Getting-started/-hydra-host-hostname-hydra-port-port-number): Lightweight indexer that directly supports connecting to a `hydra-node`
13+
14+
## Client libraries
15+
16+
- [meshjs](https://meshjs.dev/providers/hydra): Provider for the [meshjs SDK](https://meshjs.dev/) which supports the full Head life-cycle
17+
- [blaze](https://github.com/butaneprotocol/blaze-cardano/blob/main/packages/blaze-query/src/hydra.ts): Experimental provider for the [blaze SDK](https://blaze.butane.dev/)
18+
19+
20+
:::info
21+
Contributions to complete and keep this list up-to-date are more than welcome!
22+
:::

docs/sidebars.js

+1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ module.exports = {
3636
},
3737
],
3838
},
39+
"clients",
3940
"faqs",
4041
"get-involved",
4142
{

0 commit comments

Comments
 (0)