Skip to content
This repository has been archived by the owner on Dec 4, 2024. It is now read-only.

Commit

Permalink
Merge branch 'km/incorporate_docs' of https://github.com/0xPolygon/po…
Browse files Browse the repository at this point in the history
…lygon-edge into km/incorporate_docs
  • Loading branch information
kmurphypolygon committed Dec 1, 2023
2 parents a0c8cd0 + 71149ca commit dbee03d
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 7 deletions.
11 changes: 7 additions & 4 deletions wiki-docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
FROM python:3.9-alpine

RUN apk update
RUN apk add rsync
RUN apk add git
RUN apk add nodejs npm
# Install system dependencies
RUN apk update && \
apk add --no-cache rsync git nodejs npm && \
rm -rf /var/cache/apk/*

# Copy and install Python dependencies
COPY requirements.txt requirements.txt
RUN pip install -r requirements.txt --no-cache-dir

# Switch to a non-root user (if 'nonroot' is already created)
USER nonroot

# Build doc by default
Expand Down
2 changes: 1 addition & 1 deletion wiki-docs/docs/contracts/reward-pool.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Overview

`RewardPool` is library for the management and distributiion validator rewards.
`RewardPool` is library for the management and distribution of validator rewards.
Each validator has a reward pool for delegators delegating funds to them.

## Functions
Expand Down
2 changes: 1 addition & 1 deletion wiki-docs/docs/design/consensus/polybft/ibft.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ A validator's voting power is proportional to the amount of stake they have lock

PolyBFT limits network participation to around 100 validators, and a variable amount of stake is used as a fixed stake criterion to limit the system's security and can make the system economically vulnerable. The validator set in the PolyBFT does not update on each block but is fixed during n block periods known as an epoch.

The `n` block period to define one epoch is determined by governance, and until then, validators will remain the same. At the end of the epoch, a special state transaction to validatorSetManagementContract is emitted, notifying the system about the validators' uptime during the epoch. It is up to the smart contract to reward validators by their uptime and update the validator set for the next epoch. There is a function getValidatorSet which returns the current validator set at any time.
The `n` block period to define one epoch is determined by `genesis` configuration, and until then, validators will remain the same. At the end of the epoch, a special state transaction to validatorSetManagementContract is emitted, notifying the system about the validators' uptime during the epoch. It is up to the smart contract to reward validators by their uptime and update the validator set for the next epoch. There is a function getValidatorSet which returns the current validator set at any time.

!!! note
Proposer selection algorithm - Section is being updated
Expand Down
2 changes: 1 addition & 1 deletion wiki-docs/docs/operate/deploy/staking/stake.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ In this section, we'll walkthrough how to stake WMATIC on the associated rootcha

## i. Initial Staking on the Rootchain

Each validator needs to perform initial staking on the rootchain `StakeManager` contract. This is done using the `polygon-edge polybft stake` command. **Note that this command is for testing purposes only.**
Each validator needs to perform initial staking on the rootchain `StakeManager` contract. This is done using the `polygon-edge root stake` command. **Note that this command is for testing purposes only.**

<details>
<summary>Flags ↓</summary>
Expand Down

0 comments on commit dbee03d

Please sign in to comment.