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

docs: add note on tombstoning #15545

Merged
merged 2 commits into from
Mar 24, 2023
Merged

docs: add note on tombstoning #15545

merged 2 commits into from
Mar 24, 2023

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Mar 24, 2023

Description

Closes: #3732

add a note stating that once tombstoned the validators consensus key can not be reused on the chain the tombstoning happened on.

I couldnt find the original doc, went through old versions so decided to add a note only


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@tac0turtle tac0turtle added the T:Docs Changes and features related to documentation. label Mar 24, 2023
@tac0turtle tac0turtle requested a review from a team as a code owner March 24, 2023 15:32
x/staking/README.md Outdated Show resolved Hide resolved
Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com>
@tac0turtle tac0turtle merged commit 443eb3d into main Mar 24, 2023
@tac0turtle tac0turtle deleted the marko/3732 branch March 24, 2023 15:55
@@ -114,6 +114,10 @@ Validators can have one of three statuses
tombstoning, an unbonding of all their delegations begins. All delegations must then wait the UnbondingTime
before their tokens are moved to their accounts from the `BondedPool`.

:::Note
Copy link
Member

@julienrbrt julienrbrt Mar 24, 2023

Choose a reason for hiding this comment

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

This won't render nice. It had to be :::note.
image

Copy link
Member

Choose a reason for hiding this comment

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

I think it fits better as a :::warning too.

@tac0turtle tac0turtle mentioned this pull request Mar 25, 2023
19 tasks
@alexanderbez
Copy link
Contributor

Thanks @tac0turtle

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:x/staking T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: update tombstone spec to clarify current implementation
5 participants