Skip to content

Commit

Permalink
docs: fix spelling issues (#183)
Browse files Browse the repository at this point in the history
* Update mixin-kernel-node-operations.md

* Update mixin-kernel-snapshots.md

* Update mixin-kernel-transactions.md
  • Loading branch information
nnsW3 authored Dec 8, 2024
1 parent e0b3cdf commit 43007a8
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion doc/mixin-kernel-node-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ When a new Kernel Year starts or a resign transaction gets snapshot, the Kernel

- **inputs**: the single accept transaction output as the only input.

- **outputs**: one single output with type `0xa6`, the exact accept transaction amount, script `0xfffe01`, keys and mask should be derived from the payee.
- **outputs**: one single output with type `0xa6`, the exact accepted transaction amount, script `0xfffe01`, keys and mask should be derived from the payee.

- **extra**: 64 bytes same as the accept transaction extra.

Expand Down
4 changes: 2 additions & 2 deletions doc/mixin-kernel-snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Snapshot is the core of all Mixin Kernel stuffs, the Mixin Kernel BFT consensus

The current Kernel snapshot version is `0x01`, which is marshaled as a special msgpack format [https://github.com/MixinNetwork/msgpack](https://github.com/MixinNetwork/msgpack) before the snapshot hash calculation.

All snapshot related API exposed externally have and should always have a consistent JSON representation as below.
All snapshot-related API exposed externally have and should always have a consistent JSON representation as below.

```json
{
Expand Down Expand Up @@ -32,7 +32,7 @@ All snapshot related API exposed externally have and should always have a consis

- **timestamp**: a uint64 nanosecond since Unix epoch, which is provided by the leading node and agreed upon consensus.

- **topology**: a uint64 number as the snapshot order in all snapshots, this value is the only node provided value, **NOT** included in the hash and not agreed by consensus.
- **topology**: a uint64 number as the snapshot order in all snapshots, this value is the only node-provided value, **NOT** included in the hash and not agreed by consensus.

- **transaction**: HEX representation of a 32 bytes hash, which is the transaction hash included by this snapshot.

Expand Down
6 changes: 3 additions & 3 deletions doc/mixin-kernel-transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The current Kernel transaction version is `0x01`, which is marshaled as a special msgpack format [https://github.com/MixinNetwork/msgpack](https://github.com/MixinNetwork/msgpack) before the transaction hash calculation.

All transaction related API exposed externally have and should always have a consistent JSON representation of inputs and outputs, a neat UTXO model.
All transaction-related API exposed externally have and should always have a consistent JSON representation of inputs and outputs, a neat UTXO model.

```json
{
Expand Down Expand Up @@ -51,7 +51,7 @@ All transaction related API exposed externally have and should always have a con

- **version**: a uint8 number to hint the current transaction format.

The genesis input is only used when the network boot from genesis.json, only those genesis Kernel Nodes accept transactions have this kind of inputs.
The genesis input is only used when the network boot from genesis.json, only those genesis Kernel Nodes that accept transactions have this kind of inputs.

```json
{
Expand Down Expand Up @@ -104,4 +104,4 @@ The output target is always masked and can be spent according to the type and sc

- **script**: HEX representation of `{0xff, 0xfe, T}`, while `0 <= T <= 0x40`, where T is the required number of signatures from keys to spend this output.

- **type**: a uint8 number to constraint when and how this output can be spent as an input, usually 0 which means it can be spent once the script fulfilled.
- **type**: a uint8 number to constraint when and how this output can be spent as an input, usually 0 which means it can be spent once the script is fulfilled.

0 comments on commit 43007a8

Please sign in to comment.