Skip to content

Commit 14de108

Browse files
committed
Add note related to Blockfrost
Signed-off-by: Sasha Bogicevic <[email protected]>
1 parent 5560b9e commit 14de108

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/docs/configuration.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ You can also use blockfrost for script publishing. On top of providing cardano s
121121

122122
```shell
123123
hydra-node publish-scripts \
124-
--blockfrost /path/to/node.socket \
124+
--blockfrost /path/to/blockfrost-project.txt \
125125
--cardano-signing-key cardano.sk
126126
```
127127

@@ -167,7 +167,9 @@ For more details, refer to this [how to](./how-to/commit-blueprint) guide on com
167167

168168
The `hydra-node` must be connected to the Cardano network, unless running in [offline mode](./configuration.md#offline-mode).
169169

170-
A direct connection to a [`cardano-node`](https://github.com/input-output-hk/cardano-node/) is a prerequisite. Please refer to existing documentation on starting a node, for example on [developers.cardano.org](https://developers.cardano.org/docs/get-started/running-cardano), or [use Mithril](https://mithril.network/doc/manual/getting-started/bootstrap-cardano-node) to bootstrap the local node.
170+
Hydra node can talk to cardano-node directly or it can be used with the [`Blockfrost API`](https://blockfrost.io/).
171+
172+
When using a direct connection to a [`cardano-node`](https://github.com/input-output-hk/cardano-node/) please refer to existing documentation on starting a node, for example on [developers.cardano.org](https://developers.cardano.org/docs/get-started/running-cardano), or [use Mithril](https://mithril.network/doc/manual/getting-started/bootstrap-cardano-node) to bootstrap the local node.
171173

172174
To specify how to connect to the local `cardano-node`, use `--node-socket` and `--testnet-magic`:
173175

@@ -177,11 +179,18 @@ hydra-node \
177179
--node-socket devnet/node.socket \
178180
```
179181

182+
If you decide to use `Blockfrost` service then hydra-node is started with provided path to the blockfrost [project file](https://blockfrost.dev/overview/getting-started#creating-first-project):
183+
184+
```shell
185+
hydra-node \
186+
--blockfrost blockfrost-project.txt \
187+
```
188+
180189
:::info
181190
The `hydra-node` is compatible with the Cardano `mainnet` network, and can consequently operate using **real funds**. Please be sure to read the [known issues](/docs/known-issues) to fully understand the limitations and consequences of running Hydra nodes on mainnet. To choose `mainnet`, use `--mainnet` instead of `--testnet-magic`.
182191
:::
183192

184-
Using the direct node connection, the `hydra-node` synchronizes the chain and observes Hydra protocol transactions. On startup, it starts observing from the chain's tip. Once a Hydra head has been observed, the point of the last known state change is used automatically.
193+
Using the direct node connection or Blockfrost, the `hydra-node` synchronizes the chain and observes Hydra protocol transactions. On startup, it starts observing from the chain's tip. Once a Hydra head has been observed, the point of the last known state change is used automatically.
185194

186195
You can manually set the intersection point using `--start-chain-from <slot>.<hash>` which specifies a `slot` and block header `hash`. For example:
187196

0 commit comments

Comments
 (0)