Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Staking miner deposit and reward section #3954

Merged
merged 12 commits into from
Oct 28, 2022
Merged

Staking miner deposit and reward section #3954

merged 12 commits into from
Oct 28, 2022

Conversation

emresurmeli
Copy link
Contributor

Add a deposit and reward mechanics section, and use "deposit" instead of "bond" when talking about the locked-up DOT required by the staking miners. Targeting issue #3915

@emresurmeli emresurmeli added the A2 - Please Review Pull request is ready for review. label Oct 18, 2022
@emresurmeli emresurmeli requested review from alfarok and DrW3RK October 18, 2022 22:48
@emresurmeli emresurmeli self-assigned this Oct 18, 2022
@emresurmeli
Copy link
Contributor Author

cc: @kianenigma

Copy link
Contributor

@alfarok alfarok left a comment

Choose a reason for hiding this comment

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

Hey @emresurmeli, everything looks good to me! I just have 2 minor formatting related suggestions. If my suggestions look okay to you, I think you are good to merge pending any additional feedback from @DrW3RK.

docs/learn/learn-staking-miner.md Outdated Show resolved Hide resolved
components/RPC-Connection.jsx Show resolved Hide resolved
Copy link
Member

@DrW3RK DrW3RK left a comment

Choose a reason for hiding this comment

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

Thanks @alfarok Your suggestions can be committed to the PR

A few minor issues to address. The newly added content is very resourceful to understand the reward mechanics. Thanks! @emresurmeli

docs/learn/learn-staking-miner.md Outdated Show resolved Hide resolved
docs/learn/learn-staking-miner.md Outdated Show resolved Hide resolved
Copy link
Contributor

@kianenigma kianenigma left a comment

Choose a reason for hiding this comment

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

Has a few small mistakes, looks good otherwise.

@emresurmeli emresurmeli requested review from kianenigma, alfarok and DrW3RK and removed request for kianenigma October 25, 2022 19:22
@DrW3RK
Copy link
Member

DrW3RK commented Oct 26, 2022

I guess it is better to hardcode this value and modify it after the issue #3986 is resolved. I will be pushing the changes shortly

image

@DrW3RK DrW3RK merged commit dfacd76 into master Oct 28, 2022
@DrW3RK DrW3RK deleted the staking-miner-reward branch October 28, 2022 09:48
alfarok added a commit that referenced this pull request Nov 2, 2022
* Avalanche comparison (#3784)

* Add avalanche comparison page and add it to the sidebar

* Add Avalanche to the main page intro

* Add Avalanche comparison info

* Add into, model and architecture sections

* Add governance

* Add references

* Add consensus section

* Add staking and message passing

* Add upgradibility and conslusion sections

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Update docs/learn/learn-comparison-avalanche.md

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

* Rename file for conformity

* Resources added, remove to do

* Improve upon architecture and p/x chain sections

* Add comment to add infographics, and add a simple image visualizing ava network architecture

* add new section talking about founders and company

* Add ava network image

* Expand on network info

* Expand on consensus and add image

* Add consensus image

* Expand on metrics that can be changed via governance

* Add staking info and remove sharding section as it doesn't exist in Avalanche

* Grammarly

* Update docs/learn/learn-comparisons-avalanche.md

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

* Update docs/learn/learn-comparisons-avalanche.md

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

* Update docs/learn/learn-comparisons-avalanche.md

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

* Update docs/learn/learn-comparisons-avalanche.md

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

* Update docs/learn/learn-comparisons-avalanche.md

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

* Add BABE and GRANDPA links

* Add XCM and XCMP links

* Add attributes to image sources

* Add Polkadot staking mechanics to the staking section

* Rephrase conclusion

* Update docs/learn/learn-comparisons-avalanche.md

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

* Update docs/learn/learn-comparisons-avalanche.md

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

* Update docs/learn/learn-comparisons-avalanche.md

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

* Clarify Subnet section

* Clarify subnets, primary network and fix flow

* final touches

* Add Image sources to display

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

* minor fixes - avalanche page (#3963)

* minor fixes - avalanche page

* Remove physical realm section

As no comparison is provided for Polkadot

* Add Staking Page links to Nominator guide (#3965)

* Update Kusama Guide link on Nominator page

* Add note about Warp syncing (#3940)

* Add note about Warp syncing

* Reposition the note

* Update docs/maintain/maintain-guides-how-to-validate-polkadot.md

Co-authored-by: Bastian Köcher <[email protected]>

* Update maintain-guides-how-to-validate-polkadot.md

* Add description for warp sync

* add info about default sync settings

* minor fix

* Add correct info

* rephrase

Co-authored-by: Bastian Köcher <[email protected]>

* Update learn-polkadotjs.md (#3968)

minor UI issue

* Update open source stack (#3964)

* Update open source stack

Updating the security part, adding clockchain, adding Rust pdotc

* add badges

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

* Adding Primis to the open source stack (#3966)

* Adding Primis to the open source stack 

Adding Primis to the open source stack

* Add badge

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

* Address regular audit of broken external wiki links (#3969)

* start fixing links

* address broken link in build-node-management

* remove broken link as entire site is offline

* restore parachain tutorials

* don't pretty format build-open-source and fix or remove broken links

* remove support article that is no longer available

* update research link

* remove another dot leap ref

* remove radium blocks as site no longer exists

* restore links to Phragmen Voting and Justified Representation paper

* Update docs/general/kusama/kusama-community.md

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

* update radium block from io to com ext

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

* auction schedule update (#3976)

Co-authored-by: Polkadot-Kusama Bot <[email protected]>

* Update status badges (#3977)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Update build-open-source.md (#3975)

* NPoS - Remove outdated info (#3974)

- the calls to staking pallet are no longer filtered
- add link to Staking Miner

* Small change in Phragmen algorithm explainer (#3971)

If I understood the explanation correctly, I believe point (1) of the algorithm is wrong. Voters cast their vote to candidates, and not candidates to candidates. If this is wrong, please dismiss this PR.

* Update build-open-source.md (#3972)

Add Supersig

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

* Bump @polkadot/api from 9.5.2 to 9.6.1 (#3982)

Bumps [@polkadot/api](https://github.com/polkadot-js/api/tree/HEAD/packages/api) from 9.5.2 to 9.6.1.
- [Release notes](https://github.com/polkadot-js/api/releases)
- [Changelog](https://github.com/polkadot-js/api/blob/master/CHANGELOG.md)
- [Commits](https://github.com/polkadot-js/api/commits/v9.6.1/packages/api)

---
updated-dependencies:
- dependency-name: "@polkadot/api"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump immer from 9.0.15 to 9.0.16 (#3981)

Bumps [immer](https://github.com/immerjs/immer) from 9.0.15 to 9.0.16.
- [Release notes](https://github.com/immerjs/immer/releases)
- [Commits](immerjs/immer@v9.0.15...v9.0.16)

---
updated-dependencies:
- dependency-name: immer
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump katex from 0.16.2 to 0.16.3 (#3980)

Bumps [katex](https://github.com/KaTeX/KaTeX) from 0.16.2 to 0.16.3.
- [Release notes](https://github.com/KaTeX/KaTeX/releases)
- [Changelog](https://github.com/KaTeX/KaTeX/blob/main/CHANGELOG.md)
- [Commits](KaTeX/KaTeX@v0.16.2...v0.16.3)

---
updated-dependencies:
- dependency-name: katex
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Adding Polkadot Basic Notifications (#3983)

* Adding Polkadot Basic Notifications 

Adding Polkadot Basic Notifications to the tech stack

* Add status badge

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

* Improve Staking Miner intro (#3973)

* Improve Staking Miner intro

- Add links to NPoS and Offchain workers
- Run grammarly
- fix typos

* Update docs/learn/learn-staking-miner.md

Co-authored-by: Emre Surmeli <[email protected]>

Co-authored-by: Emre Surmeli <[email protected]>

* Bump jest from 29.2.1 to 29.2.2 (#3984)

Bumps [jest](https://github.com/facebook/jest/tree/HEAD/packages/jest) from 29.2.1 to 29.2.2.
- [Release notes](https://github.com/facebook/jest/releases)
- [Changelog](https://github.com/facebook/jest/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/jest/commits/v29.2.2/packages/jest)

---
updated-dependencies:
- dependency-name: jest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump jest-environment-jsdom from 29.2.1 to 29.2.2 (#3985)

Bumps [jest-environment-jsdom](https://github.com/facebook/jest/tree/HEAD/packages/jest-environment-jsdom) from 29.2.1 to 29.2.2.
- [Release notes](https://github.com/facebook/jest/releases)
- [Changelog](https://github.com/facebook/jest/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/jest/commits/v29.2.2/packages/jest-environment-jsdom)

---
updated-dependencies:
- dependency-name: jest-environment-jsdom
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Fix Formatting - Treasury page (#3987)

* Update build-open-source.md (#3988)

* Minor fix - NPoS doc

* Staking miner deposit and reward section (#3954)

* Syntax fixes

* Use deposit instead of bond in wording, and add a draft section for deposit and reward mechanics

* Finalize deposit and reward section draft

* Add signed phase parameter configuration definitions to resources

* Replace with permalinks

* Move Deposit and reward mechanics to bottom, makes more sense there

* Flush out grammar and explanation of signed phase before deposit and reward mechnics section

* Refine the deposit and reward mechanics section

* Fix consts.electionProviderMultiPhase.signedDepositByte output and add example deposit based on weight calculation

* hardcode values as temp fix

* Update docs/learn/learn-staking-miner.md

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

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

* Update status badges (#3993)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* auction schedule update (#3992)

Co-authored-by: Polkadot-Kusama Bot <[email protected]>

* Bump @docusaurus/preset-classic from 2.1.0 to 2.2.0 (#3994)

Bumps [@docusaurus/preset-classic](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-preset-classic) from 2.1.0 to 2.2.0.
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v2.2.0/packages/docusaurus-preset-classic)

---
updated-dependencies:
- dependency-name: "@docusaurus/preset-classic"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump @docusaurus/plugin-client-redirects from 2.1.0 to 2.2.0 (#3995)

Bumps [@docusaurus/plugin-client-redirects](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-plugin-client-redirects) from 2.1.0 to 2.2.0.
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v2.2.0/packages/docusaurus-plugin-client-redirects)

---
updated-dependencies:
- dependency-name: "@docusaurus/plugin-client-redirects"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump @docusaurus/module-type-aliases from 2.1.0 to 2.2.0 (#3996)

Bumps [@docusaurus/module-type-aliases](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-module-type-aliases) from 2.1.0 to 2.2.0.
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v2.2.0/packages/docusaurus-module-type-aliases)

---
updated-dependencies:
- dependency-name: "@docusaurus/module-type-aliases"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump @polkadot/api from 9.6.1 to 9.6.2 (#3998)

Bumps [@polkadot/api](https://github.com/polkadot-js/api/tree/HEAD/packages/api) from 9.6.1 to 9.6.2.
- [Release notes](https://github.com/polkadot-js/api/releases)
- [Changelog](https://github.com/polkadot-js/api/blob/master/CHANGELOG.md)
- [Commits](https://github.com/polkadot-js/api/commits/v9.6.2/packages/api)

---
updated-dependencies:
- dependency-name: "@polkadot/api"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update build-open-source.md (#4001)

* Update build-open-source.md

Add Signac

* Update badge

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

* Add Parami, update litentry (#4003)

* Add Parami, update litentry 

Add Parami to the open source stack, update litentry

* Update badge

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

* Add projects to "Easy Runtime Development" (#4004)

* Add projects to "Easy Runtime Development"  

Add projects to "Easy Runtime Development"

* Update badge

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

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Emre Surmeli <[email protected]>
Co-authored-by: Radha <[email protected]>
Co-authored-by: Bastian Köcher <[email protected]>
Co-authored-by: Anwesh <[email protected]>
Co-authored-by: David Hawig <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Polkadot-Kusama Bot <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Diogo <[email protected]>
Co-authored-by: Santi Balaguer <[email protected]>
Co-authored-by: S E R A Y A <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sebastian Müller <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Please Review Pull request is ready for review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants