Skip to content

Navigation Menu

Sign in
Sign up

Mx docs stakingv4 updates - #1047

Open
katunopolis wants to merge 21 commits into
main from
mx-docs-stakingv4-updates
Open

Mx docs stakingv4 updates #1047
katunopolis wants to merge 21 commits into
main from
mx-docs-stakingv4-updates

Conversation

@katunopolis

@katunopolis katunopolis commented Jan 23, 2025

Copy link
Copy Markdown
Contributor

Description of the pull request (what is new / what has changed)

Did you test the changes locally ?

  • yes
  • no

Which category (categories) does this pull request belong to?

  • document new feature
  • update documentation that is not relevant anymore
  • add examples or more information about a component
  • fix grammar issues
  • other

@mariusmihaic mariusmihaic left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Whole text needs to be rephrased and grammatically corrected by running it through a rephrasing app, like chatGPT
  2. We could write more straight-forward user friendly/helpful information instead of using lots of pompous words to describe a simple process, which actually describes nothing meaningful
  3. Some technical debt information proposed

Comment thread docs/validators/staking-v4-revised.md
# **1. Introduction**


## What is MultiversX staking?

@mariusmihaic mariusmihaic Feb 5, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[general]

  1. I suggest you run this whole text through chatGPT or any rephrasing tool available out there and rephrase it.
  2. Spaces/indentations seem wrong
  3. Name of the png files are not consistent with existing ones

@katunopolis katunopolis Feb 6, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Will rewrite it as suggested
  2. What are the rules for spaces/indentations?
  3. Renamed all the .png files as seen in the existing examples using all lower case and hyphen instead of spaces.

@mariusmihaic mariusmihaic Feb 12, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. 120 max characters per line before new line. Your lines are randomly interrupted


### Security

Ensured by our Auction List mechanism - that randomly selects 320 nodes, 80 nodes from each shard at every epoch start - the nodes are shuffled randomly

@mariusmihaic mariusmihaic Feb 5, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Those numbers are ideal, although can be used as referenced...
  2. I personally don't understand how auction list has anything to do with security, but that's just my opinion. If you want to keep it for marketing purposes, be it, not my call. cc @schimih

@katunopolis katunopolis Feb 6, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can use it in Security but let's see if @schimih agrees.

Comment thread docs/validators/staking-v4-revised.md Outdated

The APR of a Staking Provider is influenced by a few factors. The most important is how their Node NQT is aligned with the Network NQT. That means, the closer your Node NQT is to the Network NQT the better your APR.

An easy way to calculate this is to divide the total amount of EGLD locked in your Staking Provider contract by the number of nodes and compare it to the Network NQT. If your Staking Provider has a very high NQT compare to the Network, then your APR will be lower because the proportion of EGLD per node is not optimized.

@mariusmihaic mariusmihaic Feb 5, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, technically incorrect, can stay as it is though for marketing if that's what we want....

@mariusmihaic mariusmihaic Feb 5, 2025
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This somehow suggests that it's wrong to have lots of egld staked...

@katunopolis katunopolis Feb 6, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why it is understood like that, we could ask @schimih or @iulianpascalau to give us their views as well.

As a side note, even if the Network NQT changes in the 4 waiting Epochs the already selected nodes will still participate in the consensus even if they would presumably have lower Node NQT after the aforementioned 4 epochs in the Waiting List.


## Waiting Status

@mariusmihaic mariusmihaic Feb 5, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the difference between ## Waiting List & ## Waiting Status? they are the same thing

@katunopolis katunopolis Feb 6, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rewrote this section.

@mariusmihaic mariusmihaic Feb 12, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. You didn't re-write the text.
  2. Waiting list & Waiting status are the same thing explained twice, why do we need both?

Comment thread docs/validators/staking-v4-revised.md Outdated

## Automatic Node Qualification

This mechanism automatically distributes a Staking Provider's total top-up amount to the Validator Nodes they own.

@mariusmihaic mariusmihaic Feb 5, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need this chapter? Feels like it adds a lot of confusion. Cand be interpreted as if the system is "playing" with your own stake.

@katunopolis katunopolis Feb 6, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I rewrote it a bit, if you still think it is not bringing value we can remove it.
I added it for full transparency, perhaps a total rework of the concept description would help?

@mariusmihaic mariusmihaic Feb 12, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread docs/validators/staking-v4-revised.md Outdated

## Top-up Balancing

The point of this mechanism is to show Staking Providers their Nodes' status based on the Network NQT allowing them to adjust their number of nodes or the amount of top-up, either manually or automatically.

@mariusmihaic mariusmihaic Feb 5, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is this mechanism showed?

@katunopolis katunopolis Feb 6, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rewrote this section a bit, but as with the Automatic Node Qualification we could remove it entirely if it does not bring any usefulness.

@mariusmihaic mariusmihaic Feb 12, 2025
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @schimih I would delete both of them

Comment thread docs/validators/staking-v4.md

# **Staking V4**

Staking phase 4 will unfold in three consecutive steps, each corresponding to a specific epoch.

@mariusmihaic mariusmihaic Feb 5, 2025
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert back these deleted lines, otherwise the next chapters don't have a "seamless logic" continuation.
I understand that the document was written as in "past", for the "future" unfolding events and now it is already in the "past". Simply rephrase as those events have already happened, e.g.:
from : "In the first step, we will completely" -> "In the first step, we have completely removed"

@katunopolis katunopolis Feb 6, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted the lines as it was an error they were kept deleted

@mariusmihaic mariusmihaic Feb 12, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We still could've re-wrote the verbs to past tense

@mariusmihaic mariusmihaic Feb 12, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can stay as it is, though, it's fine

@mariusmihaic mariusmihaic left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. 80% of previous comments were not addressed
  2. Clarity, conciseness & grammatical errors + chatGpt rephrasing still not done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@schimih schimih Awaiting requested review from schimih
@iulianpascalau iulianpascalau Awaiting requested review from iulianpascalau
1 more reviewer
@mariusmihaic mariusmihaic mariusmihaic requested changes
Reviewers whose approvals may not affect merge requirements

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /