Skip to content

Commit

Permalink
docs: fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
jaybxyz committed Oct 16, 2022
1 parent d5583ec commit db134bd
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ write a little note why.
- [ ] Appropriate labels applied
- [ ] Targeted PR against correct branch
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md).
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/v0.45.3/docs/building-modules/README.md).
- [ ] Wrote unit and integration
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
- [ ] Added relevant `godoc` [comments](https://go.dev/blog/godoc).
Expand Down
2 changes: 1 addition & 1 deletion x/farming/spec/01_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ In the farming module, farming rewards are calculated per epoch based on the dis

To calculate the rewards for a single farmer, take the total rewards for the epoch before the staking started, minus the current total rewards.

The farming module takes references from [F1 Fee Distribution](https://github.com/cosmos/cosmos-sdk/blob/master/docs/spec/fee_distribution/f1_fee_distr.pdf) that is used in the Cosmos SDK [x/distribution](https://github.com/cosmos/cosmos-sdk/blob/master/x/distribution/spec/01_concepts.md) module.
The farming module takes references from [F1 Fee Distribution](https://github.com/cosmos/cosmos-sdk/blob/master/docs/spec/fee_distribution/f1_fee_distr.pdf) that is used in the Cosmos SDK [x/distribution](https://github.com/cosmos/cosmos-sdk/blob/v0.45.3/x/distribution/spec/01_concepts.md) module.

### Accumulated Unit Reward

Expand Down
4 changes: 2 additions & 2 deletions x/farming/spec/04_messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ type MsgStake struct {

A farmer must have some staking coins to trigger this message.

In contrast to the Cosmos SDK [staking](https://github.com/cosmos/cosmos-sdk/blob/master/x/staking/spec/01_state.md) module, there is no concept of an unbonding period where some time is required to unstake coins.
In contrast to the Cosmos SDK [staking](https://github.com/cosmos/cosmos-sdk/blob/v0.45.3/x/staking/spec/01_state.md) module, there is no concept of an unbonding period where some time is required to unstake coins.

All of the accumulated farming rewards are automatically withdrawn to the farmer after an unstaking event is triggered.

Expand All @@ -86,7 +86,7 @@ type MsgUnstake struct {
## MsgHarvest

The farming rewards are automatically accumulated, but they are not automatically distributed.
A farmer must harvest their farming rewards. This mechanism is similar to the Cosmos SDK [distribution](https://github.com/cosmos/cosmos-sdk/blob/master/x/distribution/spec/01_concepts.md) module.
A farmer must harvest their farming rewards. This mechanism is similar to the Cosmos SDK [distribution](https://github.com/cosmos/cosmos-sdk/blob/v0.45.3/x/distribution/spec/01_concepts.md) module.
Also, if there is `UnharvestedRewards`, unharvested rewards are also withdrawn and the object is deleted.

```go
Expand Down

0 comments on commit db134bd

Please sign in to comment.