Skip to content

Commit 86f3679

Browse files
authored
Fix instructions in our docs (#2097)
fix #2095 --- <!-- Consider each and tick it off one way or the other --> * [x] CHANGELOG updated or not needed * [x] Documentation updated or not needed * [x] Haddocks updated or not needed * [x] No new TODOs introduced or explained herafter
2 parents 11966df + eb3bcd0 commit 86f3679

File tree

5 files changed

+12
-14
lines changed

5 files changed

+12
-14
lines changed

docs/docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ You can use [jq](https://jqlang.github.io/jq/) to follow the logs and see the no
6666
following command:
6767

6868
```
69-
docker compose logs -f --no-log-prefix cardano-node | jq -Rr 'fromjson? | .data.val.kind'
69+
docker compose logs -f --no-log-prefix cardano-node | jq -Rr 'fromjson? | .data.kind'
7070
```
7171
:::
7272

docs/docs/how-to/commit-blueprint.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,7 @@ cardano-cli query utxo \
7070
Select the first `UTXO`, which has eight ada available. Use five ada to commit and rely on `hydra-node` to balance the commit transaction:
7171

7272
```shell
73-
cardano-cli transaction build-raw \
74-
--babbage-era \
73+
cardano-cli conway transaction build-raw \
7574
--tx-in 14ab373afb1112d925b0f6a84518ac26d4a8cfcc99231e1f47e6996182e843a9#0 \
7675
--tx-out addr_test1vp5cxztpc6hep9ds7fjgmle3l225tk8ske3rmwr9adu0m6qchmx5z+5000000 \
7776
--fee 0 \
@@ -167,13 +166,13 @@ Next, sign and submit the draft of the commit transaction:
167166

168167
```shell
169168

170-
cardano-cli transaction sign \
169+
cardano-cli conway transaction sign \
171170
--tx-file commit-tx.json \
172171
--signing-key-file hydra-cluster/config/credentials/alice-funds.sk \
173172
--out-file signed-tx.json
174173

175174

176-
cardano-cli transaction submit \
175+
cardano-cli conway transaction submit \
177176
--tx-file signed-tx.json \
178177
--socket-path testnets/preprod/node.socket \
179178
--testnet-magic 1

docs/docs/how-to/incremental-commit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ curl -X POST localhost:4001/commit \
5959

6060
Which we can submit to the cardano network:
6161
```shell
62-
cardano-cli transaction sign \
62+
cardano-cli conway transaction sign \
6363
--tx-file deposit-tx.json \
6464
--signing-key-file ${WALLET_SK} \
6565
--out-file deposit-tx.signed.json
6666

67-
cardano-cli transaction submit \
67+
cardano-cli conway transaction submit \
6868
--tx-file deposit-tx.signed.json
6969
```
7070

docs/docs/how-to/incremental-decommit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ For example, to spend the first UTXO queried above in a transaction sending the
5757

5858
```shell
5959
LOVELACE=$(jq -r 'to_entries[0].value.value.lovelace' < utxo.json)
60-
cardano-cli transaction build-raw \
60+
cardano-cli conway transaction build-raw \
6161
--tx-in $(jq -r 'to_entries[0].key' < utxo.json) \
6262
--tx-out ${WALLET_ADDR}+${LOVELACE} \
6363
--fee 0 \
@@ -67,14 +67,14 @@ cardano-cli transaction build-raw \
6767
You can inspect the transaction with
6868

6969
```shell
70-
cardano-cli transaction view --tx-file decommit.json
70+
cardano-cli conway transaction view --tx-file decommit.json
7171
```
7272

7373
As the transaction spends from Alice's funds in the Hydra head, we also need to
7474
sign it with her key:
7575

7676
```shell
77-
cardano-cli transaction sign \
77+
cardano-cli conway transaction sign \
7878
--tx-file decommit.json \
7979
--signing-key-file ${WALLET_SK} \
8080
--out-file alice-decommit-tx-signed.json

docs/docs/how-to/submit-transaction.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,13 @@ Below is an example response:
3232
Assuming the single UTXO is owned by `some-payment-key.sk` and you want to send all of it to another address, you can use `cardano-cli` (or your preferred transaction builder) to construct and sign a transaction:
3333

3434
```shell title="Transaction building"
35-
cardano-cli transaction build-raw \
36-
--babbage-era \
35+
cardano-cli conway transaction build-raw \
3736
--tx-in 8690d7618bb88825d6ec7cfbe2676779b8f4633cb137a1c12cd31b4c53f90f32#0 \
3837
--tx-out addr_test1vp5cxztpc6hep9ds7fjgmle3l225tk8ske3rmwr9adu0m6qchmx5z+100000000 \
3938
--fee 0 \
4039
--out-file tx.json
4140

42-
cardano-cli transaction sign \
41+
cardano-cli conway transaction sign \
4342
--tx-body-file tx.json \
4443
--signing-key-file some-payment-key.sk \
4544
--out-file tx-signed.json
@@ -53,4 +52,4 @@ This command generates a message suitable for submission to the `hydra-node` via
5352
cat tx-signed.json | jq -c '{tag: "NewTx", transaction: .}' | websocat "ws://127.0.0.1:4001?history=no"
5453
```
5554

56-
The transaction will be validated by all connected `hydra-node` instances. It will result in either a `TxInvalid` message, providing a reason for rejection, or a `TxValid` message followed by a `SnapshotConfirmed`, updating the UTXO available in the head shortly after that.
55+
`Greetings` message will be displayed as always when calling the web socket api and the transaction will be validated by all connected `hydra-node` instances. It will result in either a `TxInvalid` message, providing a reason for rejection, or a `TxValid` message followed by a `SnapshotConfirmed`, updating the UTXO available in the head shortly after that.

0 commit comments

Comments
 (0)