Skip to content

Commit

Permalink
fix(devx): Fix links and feedback (#4453)
Browse files Browse the repository at this point in the history
* fix(devx): Added 2f+1 clarification

* fix(devx): added link to docker-compose.yml

* fix(devx) removed gas price updates

* fix(devx) improve snippet

* Update docs/content/_snippets/info-BST-2f1.mdx

Co-authored-by: vivekjain23 <[email protected]>

---------

Co-authored-by: vivekjain23 <[email protected]>
  • Loading branch information
lucas-tortora and vivekjain23 authored Dec 17, 2024
1 parent d5a8e4d commit 3b6bcdc
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 29 deletions.
10 changes: 10 additions & 0 deletions docs/content/_snippets/info-BST-2f1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:::info

In Byzantine Fault Tolerant (BFT) `f` represents the number of faulty validators. `2f+1` represents the minimum number of validators
needed to agree on a transaction to ensure integrity and finality, even if up to `f` validators are faulty.

For example, if `f = 1`, this means 3 validators must confirm a transaction (a supermajority) to guarantee its
integrity,
ensuring that even if one validator is faulty, the correct decision still stands.

:::
3 changes: 3 additions & 0 deletions docs/content/about-iota/iota-architecture/epochs.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BSTInfo from '../../_snippets/info-BST-2f1.mdx';
import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/iota-architecture/epochs.json';

Expand Down Expand Up @@ -37,6 +38,8 @@ validator set and stake distribution can be altered.

### 4. Protocol Upgrade

<BSTInfo/>

If 2f+1 validators agree, the network may upgrade to a new protocol version, which includes new features, bug fixes, and
updates to the Move framework libraries.

Expand Down
3 changes: 3 additions & 0 deletions docs/content/operator/iota-full-node/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Overview
description: Operate an IOTA Full Node to validate blockchain activities, like transactions, checkpoints, and epoch changes.
---
import Quiz from '@site/src/components/Quiz';
import BSTInfo from '../../_snippets/info-BST-2f1.mdx';
import questions from '/json/node-operators/iota-full-node/overview.json';
import WarningAdvanced from './../../_snippets/warning-advanced-instructions-node-setup.mdx'

Expand All @@ -28,6 +29,8 @@ A transaction requires a few round trips to 2f+1 validators to form a transactio

This synchronization process includes:

<BSTInfo/>

1. Following 2f+1 validators and listening for newly committed transactions.
1. Making sure that 2f+1 validators recognize the transaction and that it reaches finality.
1. Executing the transaction locally and updating the local DB.
Expand Down
4 changes: 2 additions & 2 deletions nre/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Tested using:

1. Confirm you have either [Docker Engine](https://docs.docker.com/engine/install/) or [Docker Desktop](https://docs.docker.com/desktop/install/linux-install/) installed, as well as [Docker Compose](https://github.com/docker/compose#linux).

2. Update [validator.yaml](../config/validator.yaml) and place it in the same directory as `docker-compose.yaml`.
2. Update [validator.yaml](../config/validator.yaml) and place it in the same directory as [`docker-compose.yaml`](https://github.com/iotaledger/iota/blob/testnet/nre/docker/docker-compose.yaml).

Add the paths to your private keys to validator.yaml. If you chose to put them in `/opt/iota/key-pairs`, you can use the following example:

Expand All @@ -22,7 +22,7 @@ network-key-pair:
path: /opt/iota/key-pairs/network.key
```

3. Place `genesis.blob` in the same directory as `docker-compose.yaml`. (available post genesis ceremony)
3. Place `genesis.blob` in the same directory as [`docker-compose.yaml`](https://github.com/iotaledger/iota/blob/testnet/nre/docker/docker-compose.yaml). (available post genesis ceremony)

## Connectivity

Expand Down
11 changes: 0 additions & 11 deletions nre/validator_tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ This document focuses on running the Iota Node software as a Validator.
- [Chain Operations](#chain-operations)
- [Updating On-chain Metadata](#updating-on-chain-metadata)
- [Operation Cap](#operation-cap)
- [Updating the Gas Price Survey Quote](#updating-the-gas-price-survey-quote)
- [Reporting/Un-reporting Validators](#reportingun-reporting-validators)
- [Joining the Validator Set](#joining-the-validator-set)
- [Leaving the Validator Set](#leaving-the-validator-set)
Expand Down Expand Up @@ -364,16 +363,6 @@ setting the holder as the active address.
<!-- Will be fixed by issue 1867. -->
<!-- Or go to the [explorer](https://explorer.rebased.iota.org/object/0x0000000000000000000000000000000000000005) and look for `operation_cap_id` of that validator in the `validators` module. -->

### Updating the Gas Price Survey Quote

To update the Gas Price Survey Quote of a validator, which is used to calculate the Reference Gas Price at the end of
the epoch, the sender needs to hold a valid [`UnverifiedValidatorOperationCap`](#operation-cap). The sender could be the
validator itself, or a trusted delegatee. To do so, call `iota_system::request_set_gas_price`:

```shell
iota client call --package 0x3 --module iota_system --function request_set_gas_price --args 0x5 {cap_object_id} {new_gas_price} --gas-budget 10000
```

### Reporting/Un-reporting Validators

To report a validator or undo an existing report, the sender needs to hold a valid [`UnverifiedValidatorOperationCap`](#operation-cap). The sender could be the validator itself, or a trusted delegatee. To
Expand Down
16 changes: 0 additions & 16 deletions nre/validator_tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,22 +106,6 @@ Operation Cap allows a validator to authorizer another account to perform certai

The Operation Cap holder (either the validator itself or the delegatee) updates its Gas Price and reports validator peers with the Operation Cap.

#### Update Gas Price

To update Gas Price, run

```bash
$IOTA_BINARY validator update-gas-price <gas-price>
```

if the account itself is a validator and holds the Operation Cap. Or

```bash
$IOTA_BINARY validator update-gas-price --operation-cap-id <operation-cap-id> <gas-price>
```

if the account is a delegatee.

#### Report Validators

To report validators peers, run
Expand Down

0 comments on commit 3b6bcdc

Please sign in to comment.