diff --git a/CHANGELOG.md b/CHANGELOG.md index e30d9797..2fc1757a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +### [2.7.0] - UNRELEASED + +#### Added + +- Support for indexing a Hydra head. Use `--hydra-host` and `--hydra-port` to + connect `kupo` to a `hydra-node`. + ### [2.6.1] - 2023-08-30 #### Added diff --git a/docs/api/latest.yaml b/docs/api/latest.yaml index 85401b4b..3867186b 100644 --- a/docs/api/latest.yaml +++ b/docs/api/latest.yaml @@ -224,6 +224,25 @@ info: Kupo will synchronize data directly from Ogmios! Neat isn't it? + ## --hydra-host {hostname} / --hydra-port {port-number} + + Kupo can also be used to index the layer two ledger available in a + [Hydra](https://github.com/input-output-hk/hydra/#readme) head. For this, we + need to use `--hydra-host` and `--hydra-port` to point to a machine running + a `hydra-node` of a head you want to index and the port of the websocket + API. + + For example: + + ```console + $ kupo \ + --hydra-host 0.0.0.0 \ + --hydra-port 4001 \ + --since origin \ + --match * \ + --workdir ./db + ``` + ## --help In case you're lost, don't forget that a summary of this manual is available by running: diff --git a/docs/man/README.md b/docs/man/README.md index 9799ed6c..b18c269f 100644 --- a/docs/man/README.md +++ b/docs/man/README.md @@ -32,22 +32,32 @@ kupo - Fast, lightweight & configurable chain-index for Cardano. **--node-socket** : Path to the Cardano node domain socket file. - (**NOTE**: Unused when connecting to Ogmios) + (**NOTE**: Unused when connecting to Ogmios or Hydra) **--node-config** : Path to the Cardano node configuration file. - (**NOTE**: Unused when connecting to Ogmios) + (**NOTE**: Unused when connecting to Ogmios or Hydra) **--ogmios-host** : Ogmios' host address. - (**NOTE**: Unused when connecting to a Cardano node) + (**NOTE**: Unused when connecting to a Cardano node or Hydra) **--ogmios-port** : Ogmios' port. - (**NOTE**: Unused when connecting to a Cardano node) + (**NOTE**: Unused when connecting to a Cardano node or Hydra) + +**--hydra-host** +: Hydra-node host address. + + (**NOTE**: Unused when connecting to a Cardano node or Ogmios) + +**--hydra-port** +: Hydra-node port. + + (**NOTE**: Unused when connecting to a Cardano node or Ogmios) **--workdir** : Path to a working directory, where the SQLite database files are stored. By convention, the database is called kupo.sqlite. @@ -256,6 +266,13 @@ kupo - Fast, lightweight & configurable chain-index for Cardano. --since 16588737.4e9bbbb67e3ae262133d94c3da5bffce7b1127fc436e7433b87668dba34c354a\ --match addr1vyc29pvl2uyzqt8nwxrcxnf558ffm27u3d9calxn8tdudjgz4xq9p\ +**kupo**\ + --hydra-host 0.0.0.0\ + --hydra-port 4001\ + --in-memory\ + --since origin\ + --match * + # SEE ALSO Online documentation and API reference: