Skip to content

Commit 8e3e23b

Browse files
Add typos check (#2040)
1 parent f42e93b commit 8e3e23b

File tree

79 files changed

+348
-184
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+348
-184
lines changed

CHANGELOG.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ changes.
109109
- There is a new `--deposit-deadline` argument to hydra-node that determines the maximum time for the hydra-node to detect a deposit.
110110
After this time has passed users can recover a deposit in case it wasn't observed previously.
111111
112-
- **BREAKING** hydra-node accepts multiple `hydra-scripts-tx-id` as a comma-seperated list, as the outcome of changes in the Hydra scripts publishing.
112+
- **BREAKING** hydra-node accepts multiple `hydra-scripts-tx-id` as a comma-separated list, as the outcome of changes in the Hydra scripts publishing.
113113
114114
- Tested with `cardano-node 10.1.2` and `cardano-cli 10.1.1.0`.
115115
@@ -162,7 +162,7 @@ changes.
162162
163163
- Adds a manual recipient address entry to `hydra-tui` and fixes event handling. [#1607](https://github.com/cardano-scaling/hydra/pull/1607)
164164
165-
- Add a demo mode to hydra-cluster to facilitate network resiliance tests [#1552](https://github.com/cardano-scaling/hydra/pull/1552)
165+
- Add a demo mode to hydra-cluster to facilitate network resilience tests [#1552](https://github.com/cardano-scaling/hydra/pull/1552)
166166
167167
## [0.18.1] - 2024-08-15
168168
@@ -191,15 +191,15 @@ changes.
191191
192192
- Change `--start-chain-from` to always use the newer point when also a head state is known. [#1471](https://github.com/cardano-scaling/hydra/pull/1471)
193193
194-
- Moved several pages from "core concepts" into the user manual and developer docs to futher improve user journey. [#1486](https://github.com/cardano-scaling/hydra/pull/1486)
194+
- Moved several pages from "core concepts" into the user manual and developer docs to further improve user journey. [#1486](https://github.com/cardano-scaling/hydra/pull/1486)
195195
196196
- Offline mode of `hydra-node` uses `--node-id` to derive an artificial offline `headId`. [#1551](https://github.com/cardano-scaling/hydra/pull/1551)
197197
198198
## [0.17.0] - 2024-05-20
199199
200200
- **BREAKING** Change `hydra-node` API `/commit` endpoint for committing from scripts [#1380](https://github.com/cardano-scaling/hydra/pull/1380):
201201
- Instead of the custom `witness` extension of `UTxO`, the endpoint now accepts a _blueprint_ transaction together with the `UTxO` which is spent in this transaction.
202-
- Usage is still the same for commiting "normal" `UTxO` owned by public key addresses.
202+
- Usage is still the same for committing "normal" `UTxO` owned by public key addresses.
203203
- Spending from a script `UTxO` now needs the `blueprintTx` request type, which also unlocks more involved use-cases, where the commit transaction should also satisfy script spending constraints (like additional signers, validity ranges etc.)
204204
205205
- _DEPRECATED_ the `GetUTxO` client input and `GetUTxOResponse` server output. Use `GET /snapshot/utxo` instead.
@@ -441,14 +441,14 @@ changes.
441441
spend multiple UTxOs into a Hydra head.
442442
- Removes the `MoreThanOneUTxOCommitted` server output on the API.
443443
444-
- Suport commits from external wallets [#215](215)
444+
- Support commits from external wallets [#215](215)
445445
- Added the `/commit` HTTP endpoint to the `hydra-node` for creating a draft
446446
`commit` transaction to commit requested UTxO into a head. This
447447
transaction can be signed and submitted to the network by the hydra client
448448
now instead of `hydra-node`.
449449
- Commits via `/commit` also allow to commit scripts into a Hydra Head. For
450450
that, the UTxO entry in the HTTP request needs to provide a `witness` with
451-
scrpit, datum, and redeemer to be used.
451+
script, datum, and redeemer to be used.
452452
- Removed the need to mark fuel when using external commits. Fees for Hydra
453453
protocol transactions are paid the largest UTxO held by the internal
454454
wallet if no marked fuel UTxO is present.
@@ -834,7 +834,7 @@ changes.
834834
835835
- Implement on-chain contestation logic [#192](https://github.com/cardano-scaling/hydra/issues/192):
836836
+ Node will automatically post a `Contest` transaction when it observes a `Close` or `Contest` with an obsolete snapshot
837-
+ Posting a fan-out transaction is not possible before the contestation dealine has passed
837+
+ Posting a fan-out transaction is not possible before the contestation deadline has passed
838838
839839
- Transactions can now be submitted as raw CBOR-serialized object, base16 encoded, using the `NewTx` client input. This also supports the text-envelope format from cardano-cli out of the box. See the [api Reference](https://hydra.family/head-protocol/api-reference#operation-publish-/-message).
840840
@@ -893,7 +893,7 @@ changes.
893893
- **BREAKING** Renamed server output `UTxO -> GetUTxOResponse`
894894
+ This should be a better name for the response of `GetUTxO` client input on our API :)
895895
896-
- Updated our dependencies (`plutus`, `cardano-ledger`, etc.) to most recent released versions making scripts smaller and Head transactions slighly cheaper already, see benchmarks for current limits.
896+
- Updated our dependencies (`plutus`, `cardano-ledger`, etc.) to most recent released versions making scripts smaller and Head transactions slightly cheaper already, see benchmarks for current limits.
897897
898898
#### Fixed
899899
@@ -1002,7 +1002,7 @@ changes.
10021002
- Recipient addresses to send money to in the TUI are inferred from the current
10031003
UTXO set. If a party does not commit a UTXO or consumes all its UTXO in a
10041004
Head, it won't be able to send or receive anything anymore.
1005-
- TUI crashes when user tries to post a new transaction wihout any UTXO
1005+
- TUI crashes when user tries to post a new transaction without any UTXO
10061006
remaining.
10071007
- Not an issue, but a workaround: The internal wallet of `hydra-node` requires a
10081008
UTXO to be marked as "fuel" to drive the Hydra protocol transactions.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Please include as much details as needed to clearly qualify the issue:
6161

6262
6. **Release**: The team creates and publish a release that includes the fix
6363

64-
7. **Announcement**: Concommitant to the release annoucement, the team announces the security vulnerability by making the GitHub issue public. This is the first point that any information regarding the vulnerability is made public.
64+
7. **Announcement**: Concommitant to the release announcement, the team announces the security vulnerability by making the GitHub issue public. This is the first point that any information regarding the vulnerability is made public.
6565

6666
a. **Credit**: The team publicly acknowledges the contributions of the
6767
reporter once the vulnerability is resolved, subject to the

docs/adr/2021-06-05_001-record-architectural-decisions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Accepted
1414

1515
We are in search for a means to describe our technical architecture.
1616

17-
We are a small team working in a very lean and agile way (XP), so we naturally prefer also light-weight documentation methods which also accomodate change easily.
17+
We are a small team working in a very lean and agile way (XP), so we naturally prefer also light-weight documentation methods which also accommodate change easily.
1818

1919
## Decision
2020

docs/adr/2021-08-19_009-simplify-logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Accepted
1616
* Providing the needed components and tools to be able to configure logging and monitoring to each operator's liking should not be the responibility of the Hydra node, and requires complex machinery that will need to be maintained and evolved
1717
* When a problem occurs in production, if the process is not verbose enough it can be very hard to analyse the problem
1818
* Enabling dynamic changes of verbosity in logs is both complex to implement and comes too late
19-
* Deciding in the code on what's the right "severity" for a log entry leads to dropping important information on _how_ some error occured
19+
* Deciding in the code on what's the right "severity" for a log entry leads to dropping important information on _how_ some error occurred
2020

2121
## Decision
2222

docs/adr/2022-07-22_019-reference-scripts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Accepted
3232

3333
* Publish outputs holding Hydra scripts out-of-band (option 2), because
3434
+ All scripts would not fit into the `init` transaction directly, we would need to post multiple.
35-
+ Costs (deposits) would need to be payed for each head instance.
35+
+ Costs (deposits) would need to be paid for each head instance.
3636

3737
* The scripts are stored at outputs addressed to some **unspendable** `v_publish` validator.
3838
+ This is to avoid DoS risk and unnecessariy centralization

docs/adr/2022-12-05_021-Bounded-transaction-validity-on-Hydra-protocol-transactions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Accepted
3737
upper bound on the `closeTx`. This was also required so far to compute the
3838
contestation deadline.
3939

40-
- Different networks (chains) have different slot lenghts, e.g. the preview
40+
- Different networks (chains) have different slot lengths, e.g. the preview
4141
network has a slot every `1s`, while our local devnets use `0.1s`. This means
4242
hardcoded values like `closeGraceTime` need to be _in sync_ with the
4343
underlying network.
@@ -105,5 +105,5 @@ Accepted
105105
constructing transactions since we cannot convert arbitrary point in times to
106106
slots.
107107

108-
- All parties need to aggree on contestation period before trying to run a Head
108+
- All parties need to agree on contestation period before trying to run a Head
109109
protocol otherwise InitTx will be ignored.

docs/adr/2023-04-26_023-local-chain-state.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Accepted
2727
- [#185](https://github.com/cardano-scaling/hydra/issues/185) plans to improve
2828
rollback management.
2929

30-
The following picture details the race condition through an exemple:
30+
The following picture details the race condition through an example:
3131

3232
1. The DirectChain component fetch some `chainState 0` from the `headState`
3333

docs/adr/2023-09-09_027-network-resilience.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Therefore, the scope of this ADR is to address only point 1. above: Ensure broad
3333
* It also takes care of reconnecting to peers when a failure is detected which relieves us from doing so, but any reconnection implies a reset of each peer's state machine which means we need to make sure any change to the state of pending/received messages is handled by the applicative layer
3434
* Our [FireForget protocol](https://github.com/cardano-scaling/hydra/blob/8a8e0829964132bde8949e5249a1ab303af92fb8/hydra-node/src/Hydra/Network/Ouroboros/Type.hs#L31) ignores connections/disconnections
3535
* Ouroboros/typed-protocols provides enough machinery to implement a reliable broadcast protocol, for example by reusing existing `[KeepAlive](https://github.com/input-output-hk/ouroboros-network/tree/master/ouroboros-network-protocols/src/Ouroboros/Network/Protocol/KeepAlive)` protocol and building a more robust point-to-point protocol than what we have now
36-
* There is a minor limitation, namely that the subscription mechanism does not handle connections invidually, but as a set of equivalent point-to-point full duplex connections whose size (valency) needs to be maintained at a certain threshold, which means that unless backed in the protocol itself, protocol state-machine and applications are not aware of the identity of the remote peer
36+
* There is a minor limitation, namely that the subscription mechanism does not handle connections individually, but as a set of equivalent point-to-point full duplex connections whose size (valency) needs to be maintained at a certain threshold, which means that unless backed in the protocol itself, protocol state-machine and applications are not aware of the identity of the remote peer
3737
* We have built our `Network` infrastructure over the concept of relatively independent layers, each implementing a similar interface with different kind of messages, to `broadcast` messages to all peers and be notified of incoming messages through a `callback`.
3838
* This pipes-like abstraction allows us to compose our network stack like:
3939

docs/adr/2024-01-27_031-constant-memory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ used to serve in-memory data are using a common haskell list as a data
2222
structure. We should stream the data keeping the memory bounded as the first
2323
optimisation.
2424

25-
It is also not necesary to output the whole history of messages by default and
25+
It is also not necessary to output the whole history of messages by default and
2626
only do that if clients request to see the whole history. Internally our
2727
`ServerOutput` type could be remapped to `StateChanged` since the two are
2828
almost identical. Any new information must be streamed to the clients

docs/adr/2025-02-12_032-network-properties-etcd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ Accepted
5959
- Docker image users should not see any different UX
6060
- We can ship the binary through `hydra-node`.
6161

62-
- Introspectability network as the `etcd` cluster is queriable could improve debugging experience
62+
- Introspectability network as the `etcd` cluster is queryable could improve debugging experience
6363

6464
- Persisted state for networking changes as there will be no `acks`, but the `etcd` Write Ahead Log (WAL) and a last seen revision.
6565

6666
- Can keep same user experience on configuration
67-
- Full, static topology with listing everone as `--peer`
67+
- Full, static topology with listing everyone as `--peer`
6868
- Simpler configuration via [peer discovery](https://etcd.io/docs/v3.5/op-guide/clustering/#discovery) possible
6969

7070
- `PeerConnected` semantics needs to change to an overall `HydraNetworkConnected`

0 commit comments

Comments
 (0)