Docs update for Yamuna protocol upgrade

cmjc commented 3 months ago

This PR updates the docs for the Yamuna protocol upgrade.

Edits detailed beneath.

Home page.

Adds hyperlinks to the Home page to the AOS and AGC repos.

Edits to Concepts Validator and System model.

Edits for #173 and improves System model to better explain the new autonitykeys model in the section on Participants (i.e. nodes).

closes #173

Edits to Concept Accountability.

Edits for #197 in https://docs.autonity.org/concepts/accountability/#slashing-penalties table to clarify slashed NTN goes to protocol treasury account for community funding

closes #197

Edits to Concepts Validator, Staking, System model, and Accountability - economics sections.

Edits for #186 and #178 clarifying validator economics (incentives and disincentives), and harmonising table formatting with the parallel economics table in Accountability under slashing economics.

closes #186 closes #178

Networks

Updated chainId (increments by 1)
Genesis configuration. Removed listings of validator enodes and replaced with link to the Piccadilly and Bakerloo Chain Config Validators object in AGC /params/config.go to simplify.
Fixed link to PCGC Bug bounty on Piccadilly Testnet page introduction

closes #188 closes #193

Development, Deploy smart contracts to an Autonity network with Brownie

Updated Piccadilly chainId to the new value

closes #194

EIP 1559 configuration and setting edits

Corrected to 20M setting introduced in v0.13.0 release
Edits to Reference, Genesis and Concepts, System model, Autonity EIP 1559 Configuration

Commit: dba7e3f7730439d5f420910866c85421fc3c67ed.

Correct Auton Currency Unit to Autonomous Currency Unit

Edits to:

Glossary (ACU entry)
Reference, Genesis
Reference, Autonity Contract Interface, Operator and Protocol Only
Overview
Concepts, Architecture
Concepts, ASM, Overview

Commit: a19aa656a342ba71038670dac2bd6858c35fc385.

Edits for BLS Aggregation

Edits for use of BLS to create an aggregate signature for consensus voting, replacing the previous committedSeals with aquorumCertificate:

Concepts, System model
Concepts, Architecture, Communication layer
Concepts, Consensus, Tendermint BFT consensus

Commit: ced1c113b2cb0d332e4f1ec05b3f02a931cd4a42.

Node migration and validator enode update

Edits to Node operator and Validator guides to:

Node operator, Run Autonity: move migrating a node to a separate page Migrate Autonity and edit
Validators: add page Migrate Validator detailing how to migrate to a new environment, update the validator's registered enode URL.

Commit: 2eae37156c989fc1658105fdb870a3869ca60149.

Edits to CLI Reference

Command line (AGC):

NETWORKING OPTIONS: add new flag --nogossip

Commit: ee6a439500d8ed543dc57c8c04d34625847cf745.

(Command line (AOS) - no changes in v0.1.8)

cmjc commented 3 months ago

@aiman @yazzaoui @Jason-Zhangxin-Chen @lorenzo-dev1 @vpiyush @tbssajal

Marking ready for review. This provides a baseline of the docs for users and node/validator operators.

I will do a second PR with edits for:

tokenomics, inflation mechanism
edits from QA checks against:
- protocol parameters
- open issues

aiman commented 3 months ago

I think we can merge for now and continue to iterate in future PR as more people review the live site.

autonity / docs.autonity.org