Skip to content

Commit

Permalink
docs: fix transaction typos, grammar and documentation links (#4098)
Browse files Browse the repository at this point in the history
1. Fix typos in transaction-related terms:
   - "transacton" → "transaction"
   - "transcation" → "transaction"
   - "WantMsg" → "WantTx"

2. Fix grammar:
   - "blobs must be placed is a way" → "blobs must be placed in a way"

3. Update environment variable name for consistency:
   - "KNUUU_TIMEOUT" → "KNUU_TIMEOUT"

4. Fix apostrophe usage:
   - "TTL's" → "TTLs"

5. Update minikube documentation link:
- Change from French version (kubernetes.io/fr/) to English version
(kubernetes.io/docs/)
  • Loading branch information
savvar9991 authored Dec 9, 2024
1 parent f11a169 commit 521543d
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions specs/src/cat_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Both `SeenTx` and `WantTx` contain the sha256 hash of the raw transaction bytes.
Both messages are sent across a new channel with the ID: `byte(0x31)`. This enables cross compatibility as discussed in greater detail below.

> **Note:**
> The term `SeenTx` is used over the more common `HasTx` because the transaction pool contains sophisticated eviction logic. TTL's, higher priority transactions and reCheckTx may mean that a transaction pool *had* a transaction but does not have it any more. Semantically it's more appropriate to use `SeenTx` to imply not the presence of a transaction but that the node has seen it and dealt with it accordingly.
> The term `SeenTx` is used over the more common `HasTx` because the transaction pool contains sophisticated eviction logic. TTLs, higher priority transactions and reCheckTx may mean that a transaction pool *had* a transaction but does not have it any more. Semantically it's more appropriate to use `SeenTx` to imply not the presence of a transaction but that the node has seen it and dealt with it accordingly.
## Outbound logic

Expand Down Expand Up @@ -88,7 +88,7 @@ Upon receiving a `SeenTx` message:
- If the node does not have the transaction but recently evicted it, it MAY choose to rerequest the transaction if it has adequate resources now to process it.
- If the node has not seen the transaction or does not have any pending requests for that transaction, it can do one of two things:
- It MAY immediately request the tx from the peer with a `WantTx`.
- If the node is connected to the peer specified in `FROM`, it is likely, from a non-byzantine peer, that the node will also shortly receive the transaction from the peer. It MAY wait for a `Txs` message for a bounded amount of time but MUST eventually send a `WantMsg` message to either the original peer or any other peer that *has* the specified transaction.
- If the node is connected to the peer specified in `FROM`, it is likely, from a non-byzantine peer, that the node will also shortly receive the transaction from the peer. It MAY wait for a `Txs` message for a bounded amount of time but MUST eventually send a `WantTx` message to either the original peer or any other peer that *has* the specified transaction.

Upon receiving a `WantTx` message:

Expand Down
2 changes: 1 addition & 1 deletion specs/src/data_square_layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The order of blobs in a namespace is dictated by the priority of the PFBs that p

Transactions can pay fees for a blob to be included in the same block as the transaction itself. It may seem natural to bundle the `MsgPayForBlobs` transaction that pays for a number of blobs with these blobs (which is the case in other blockchains with native execution, e.g. calldata in Ethereum transactions or OP_RETURN data in Bitcoin transactions), however this would mean that processes validating the state of the Celestia network would need to download all blob data. PayForBlob transactions must therefore only include a commitment to (i.e. some hash of) the blob they pay fees for. If implemented naively (e.g. with a simple hash of the blob, or a simple binary Merkle tree root of the blob), this can lead to a data availability problem, as there are no guarantees that the data behind these commitments is actually part of the block data.

To that end, we impose some additional rules onto _blobs only_: blobs must be placed is a way such that both the transaction sender and the block producer can be held accountable—a necessary property for e.g. fee burning. Accountable in this context means that
To that end, we impose some additional rules onto _blobs only_: blobs must be placed in a way such that both the transaction sender and the block producer can be held accountable—a necessary property for e.g. fee burning. Accountable in this context means that

1. The transaction sender must pay sufficient fees for blob inclusion.
1. The block proposer cannot claim that a blob was included when it was not (which implies that a transaction and the blob it pays for must be included in the same block). In addition all blobs must be accompanied by a PayForBlob transaction.
Expand Down
4 changes: 2 additions & 2 deletions test/e2e/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ make test-e2e E2ESimple

**Optional parameters**:

- `KNUUU_TIMEOUT` can be used to override the default timeout of 60 minutes for the tests.
- `KNUU_TIMEOUT` can be used to override the default timeout of 60 minutes for the tests.

## Observation

Expand All @@ -56,7 +56,7 @@ This will back up your default kubernetes configuration. If you use a different

### Install minikube

Minikube is required to be installed on your machine. If you have a linux machine, follow the [minikube docs](https://kubernetes.io/fr/docs/tasks/tools/install-minikube/). If you're on macOS ARM, this [tutorial](https://devopscube.com/minikube-mac/) can be helpful to run it using qemu.
Minikube is required to be installed on your machine. If you have a linux machine, follow the [minikube docs](https://kubernetes.io/docs/tasks/tools/install-minikube/). If you're on macOS ARM, this [tutorial](https://devopscube.com/minikube-mac/) can be helpful to run it using qemu.

### Create namespace

Expand Down

0 comments on commit 521543d

Please sign in to comment.