Skip to content

Commit

Permalink
Fix documentation typos (#2664)
Browse files Browse the repository at this point in the history
  • Loading branch information
dastansam authored Apr 4, 2024
1 parent 1cff1e9 commit 1fc8f8a
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 17 deletions.
16 changes: 8 additions & 8 deletions crates/pallet-grandpa-finality-verifier/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# pallet-grandpa-finality-verifier
License: Apache-2.0

GRANDPA finality verifier is used to verify the justifications provided within the substrate based Blocks indexing them on our DSN.
GRANDPA finality verifier is used to verify the justifications provided within the substrate based blocks indexing them on our DSN.

The pallet provides the following functionality
- provides a basic abstraction over any substrate based chains through `Chain` trait.
- decodes the block and its components.
- verifies the blocks and its justifications using the current authority set the block was produced in
- imports any authority set changes from the header after the verification
The pallet is responsible for:
- providing a basic abstraction over any substrate based chains through `Chain` trait.
- decoding the block and its components.
- verifying the blocks and its justifications using the current authority set the block was produced in.
- importing any authority set changes from the header after the verification.

This pallet does not
- verifies or recognizes the forks. So this is left for the admin to reinitialize the chain state after the fork
This pallet is not responsible for:
- verifying or recognizing the forks. So this is left for the admin to reinitialize the chain state after the fork.
5 changes: 3 additions & 2 deletions crates/subspace-farmer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ sudo apt-get install automake libtool pkg-config llvm clang protobuf-compiler
1. Install via Homebrew:

```bash
brew install automake libtool llvm clang protobuf
brew install automake libtool llvm protobuf
```

2. Add `llvm` to your `~/.zshrc` or `~/.bashrc`:

```bash
export PATH="/opt/homebrew/opt/llvm@15/bin:$PATH"
export PATH="/opt/homebrew/opt/llvm/bin:$PATH"
```

3. Activate the changes:
Expand All @@ -55,6 +55,7 @@ target/production/subspace-farmer --version
```

## Usage

Commands here assume you installed native binary, but you can also easily adapt them to using with Docker.

Use `--help` to find out all available commands and their options:
Expand Down
4 changes: 2 additions & 2 deletions crates/subspace-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ sudo apt-get install llvm clang cmake make protobuf-compiler
1. Install via Homebrew:

```bash
brew install llvm clang cmake make protobuf
brew install llvm cmake make protobuf
```

2. Add `llvm` to your `~/.zshrc` or `~/.bashrc`:

```bash
export PATH="/opt/homebrew/opt/llvm@15/bin:$PATH"
export PATH="/opt/homebrew/opt/llvm/bin:$PATH"
```

3. Activate the changes:
Expand Down
2 changes: 1 addition & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Check [crates/subspace-node](../crates/subspace-node/README.md) and [crates/subs
## To Farm By Yourself (Offline)

1. Download the executables for your operating system
2. Open your favourite terminal, and go to the folder where you download the executables
2. Open your favourite terminal, and go to the folder where you downloaded the executables

**Linux/MacOS:**

Expand Down
10 changes: 6 additions & 4 deletions domains/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ Domains are the decoupled execution layer of the [Subspace Network Blockchain](h

The extrinsic of the domain chain is first collected into a bundle by the domain operator, the bundle is then broadcast to the consensus chain network as an extrinsic of the consensus chain.

The domain operator listening to the block import events of the consensus chain, extracts bundles from the imported consensus block and executes the extrinsics of the bundle to build and import a domain block in a deterministically way.
The domain operator, which listens to the block import events of the consensus chain, extracts bundles from the imported consensus block and executes the extrinsics of the bundle to build and import a domain block in a deterministic manner.

NOTE: currently, the domain chain does not support to syncing from other operator nodes and need to be deterministically derived from the consensus chain block by block.
NOTE: Currently, the domain chain does not support syncing from other operator nodes. It must be deterministically derived from the consensus chain block by block.

#### Create Operator key:

Operator needs key pair to participate in Bundle production.
You can create a key using following command:
```bash
Expand All @@ -37,12 +38,13 @@ target/production/subspace-node domain key insert \
The above command assumes `{subspace-node-base-path}` as the location of node data. `{domain-id}` is a domain for which to insert the key and `{secret-phrase}` is the secret phrase to use for keypair derivation.

#### Register Operator:

Operator needs to register to a domain they want to operate on using `register_operator`. Registration extrinsic requires Operator Config.
Once the domain epoch is finished, Operator can produce bundles from the new epoch.

### Start the domain operator node

The domain operator node is running with an embededded consensus node, thus you need to specify the args for both the consensus node and the domain operator node:
The domain operator node runs with an embededded consensus node, thus you need to specify the args for both the consensus node and the domain operator node:

```bash
subspace-node [consensus-chain-args] -- [domain-args]
Expand Down Expand Up @@ -94,4 +96,4 @@ target/production/subspace-node --dev -- --help

### Build from source

The domain operator node is embedded within the `subspace-node` binary, please refer to [Subspace node](../crates/subspace-node/README.md) for how to build from source.
The domain operator node is embedded within the `subspace-node` binary, please refer to [Subspace node](../crates/subspace-node/README.md) for building it from source.

0 comments on commit 1fc8f8a

Please sign in to comment.