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.

Sign up for GitHub

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

Jump to bottom

docs(x/staking-upgrade): fix proto broken links #20202

Closed
wants to merge 4 commits into from
Closed

docs(x/staking-upgrade): fix proto broken links #20202

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4138924
docs: fix proto link in x/upgrade
kien6034 Apr 28, 2024
d80106a
docs: fix proto link in x/staking
kien6034 Apr 28, 2024
c2f8c49
chore: add commit ref instead of main
kien6034 May 2, 2024
e95abdd
Merge branch 'main' into fix/module-broken-links
kien6034 May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
52 changes: 26 additions & 26 deletions x/staking/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ it can be updated with governance or the address with authority.
* Params: `0x51 | ProtocolBuffer(Params)`

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/staking.proto#L310-L333
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/staking.proto#L310-L339
```

### Validator
Expand Down Expand Up @@ -151,11 +151,11 @@ is updated during the validator set update process which takes place in [`EndBlo
Each validator's state is stored in a `Validator` struct:

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/staking.proto#L82-L138
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/staking.proto#L102-148
```

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/staking.proto#L26-L80
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/staking.proto#L40-L64
```

### Delegation
Expand All @@ -171,7 +171,7 @@ delegator, and is associated with the shares for one validator. The sender of
the transaction is the owner of the bond.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/staking.proto#L198-L216
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/staking.proto#L204-L221
```

#### Delegator Shares
Expand Down Expand Up @@ -219,7 +219,7 @@ detected.
A UnbondingDelegation object is created every time an unbonding is initiated.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/staking.proto#L218-L261
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/staking.proto#L223-L264
```

### Redelegation
Expand Down Expand Up @@ -261,7 +261,7 @@ A redelegation object is created every time a redelegation occurs. To prevent
where the source validator for this new redelegation is `Validator X`.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/staking.proto#L263-L308
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/staking.proto#L267-L310
```

## ConsPubkeyRotation
Expand Down Expand Up @@ -320,7 +320,7 @@ delegations queue is kept.
* UnbondingDelegation: `0x41 | format(time) -> []DVPair`

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/staking.proto#L162-L172
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/staking.proto#L170-L179
```

#### RedelegationQueue
Expand All @@ -331,7 +331,7 @@ kept.
* RedelegationQueue: `0x42 | format(time) -> []DVVTriplet`

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/staking.proto#L179-L191
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/staking.proto#L186-L197
```

#### ValidatorQueue
Expand All @@ -358,7 +358,7 @@ Whenever the next item with the same waiting time comes to the queue, we will ge
the present store info and append the `ValAddress` to the array and set it back in the store.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/8f0d5b15f0b10da7645d7fc1aa868fe44e3f3a44/proto/cosmos/staking/v1beta1/staking.proto#L429-L433
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/staking.proto#L431-L435
```

### HistoricalInfo
Expand All @@ -367,7 +367,7 @@ HistoricalInfo objects are stored and pruned at each block such that the staking
the `n` most recent historical info defined by staking module parameter: `HistoricalEntries`.

```go reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/staking.proto#L17-L24
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/staking.proto#L17-L26
```

At each BeginBlock, the staking keeper will persist the current Header and the Validators that committed
Expand Down Expand Up @@ -572,11 +572,11 @@ A validator is created using the `MsgCreateValidator` message.
The validator must be created with an initial delegation from the operator.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L20-L21
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L20-L21
```

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L50-L73
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L56-L78
```

This message is expected to fail if:
Expand All @@ -601,11 +601,11 @@ The `Description`, `CommissionRate` of a validator can be updated using the
`MsgEditValidator` message.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L23-L24
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L23-L24
```

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L78-L97
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L78-L97
```

This message is expected to fail if:
Expand All @@ -624,11 +624,11 @@ some amount of their validator's (newly created) delegator-shares that are
assigned to `Delegation.Shares`.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L26-L28
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L26-L28
```

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L102-L114
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L102-L114
```

This message is expected to fail if:
Expand Down Expand Up @@ -660,17 +660,17 @@ The `MsgUndelegate` message allows delegators to undelegate their tokens from
validator.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L34-L36
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L34-L36
```

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L140-L152
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L140-L152
```

This message returns a response containing the completion time of the undelegation:

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L154-L158
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L154-L158
```

This message is expected to fail if:
Expand Down Expand Up @@ -699,11 +699,11 @@ When this message is processed the following actions occur:
The `MsgCancelUnbondingDelegation` message allows delegators to cancel the `unbondingDelegation` entry and delegate back to a previous validator. However, please note that this feature does not support canceling unbond delegations from jailed validators.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L38-L42
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L38-L42
```

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L160-L175
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L160-L175
```

This message is expected to fail if:
Expand All @@ -727,17 +727,17 @@ the unbonding period has passed, the redelegation is automatically completed in
the EndBlocker.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L30-L32
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L30-L32
```

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L119-L132
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L119-L132
```

This message returns a response containing the completion time of the redelegation:

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L133-L138
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L133-L138
```

This message is expected to fail if:
Expand Down Expand Up @@ -771,7 +771,7 @@ The params are updated through a governance proposal where the signer is the gov
When the `MinCommissionRate` is updated, all validators with a lower (max) commission rate than `MinCommissionRate` will be updated to `MinCommissionRate`.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L182-L195
https://github.com/cosmos/cosmos-sdk/blob/main/x/staking/proto/cosmos/staking/v1beta1/tx.proto#L182-L195
```

The message handling can fail if:
Expand All @@ -784,7 +784,7 @@ The `MsgRotateConsPubKey` updates the consensus pubkey of a validator
with a new pubkey, the validator must pay rotation fees (default fee 1000000stake) to rotate the consensus pubkey.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/efa7636756ad0164ae5ef75f958ffec95a4201a4/proto/cosmos/staking/v1beta1/tx.proto#L213-L226
https://github.com/cosmos/cosmos-sdk/blob/x/main/staking/proto/cosmos/staking/v1beta1/tx.proto#L213-L226
```

The message handling can fail if:
Expand Down
4 changes: 2 additions & 2 deletions x/upgrade/README.md
View file
Open in desktop
Copy link
Contributor Author

@kien6034 kien6034 May 2, 2024 •
edited

Choose a reason for hiding this comment

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

@julienrbrt sorry for the late update, i took some days off for our holiday. Should we do this instead?

Copy link
Member

Choose a reason for hiding this comment

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

lets use a tag, there isnt much benefit to a commit here

Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ the `Plan`, which targets a specific `Handler`, is persisted and scheduled. The
upgrade can be delayed or hastened by updating the `Plan.Height` in a new proposal.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/upgrade/v1beta1/tx.proto#L29-L41
https://github.com/cosmos/cosmos-sdk/blob/main/x/upgrade/proto/cosmos/upgrade/v1beta1/tx.proto#L29-L41
```

#### Cancelling Upgrade Proposals
Expand All @@ -115,7 +115,7 @@ Of course this requires that the upgrade was known to be a bad idea well before
upgrade itself, to allow time for a vote.

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/upgrade/v1beta1/tx.proto#L48-L57
https://github.com/cosmos/cosmos-sdk/blob/main/x/upgrade/proto/cosmos/upgrade/v1beta1/tx.proto#L48-L56
```

If such a possibility is desired, the upgrade height is to be
Expand Down