docs(lockup): add documentation #19898
Conversation
WalkthroughWalkthroughThe update enriches the Changes
Recent Review DetailsConfiguration used: .coderabbit.yml Files selected for processing (1)
Additional Context UsedLanguageTool (23)
Path-based Instructions (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 7
Configuration used: .coderabbit.yml
Files selected for processing (1)
- x/accounts/defaults/lockup/README.md (1 hunks)
Path instructions used (1)
x/accounts/defaults/lockup/README.md (1)
**/*.md
Assess the documentation for misspellings, grammatical errors, missing documentation and correctness
Additional comments (8)
x/accounts/defaults/lockup/README.md (8)
- 1-1: The title "LockUp Accounts" might be a spelling mistake or could be improved for clarity. Consider using "Lockup Accounts" for consistency with common terminology.
- 44-44: The phrase "amount of coins" is used, which might be better expressed as "number of coins" since coins are countable.
Consider revising to "number of coins" for grammatical accuracy.
- 47-47: The phrase "Compute Compute" seems to be a duplication error in the context provided by the static analysis tool. However, this appears to be a false positive as the context does not show duplicated "Compute" in the documentation.
- 52-52: The symbol ‘'’ in
V'seems to be flagged as unpaired, which is likely a false positive since this notation is commonly used in mathematical expressions to denote a variant of a variable.- 76-76: The phrase "calculating the coins released during each period for a given block time
T" might be missing a preposition before "each period." However, this seems to be a false positive as the sentence is grammatically correct and clear in its current form.- 78-78: The phrase "Set
CT := StartTime2. SetV' := 0" is flagged for repeating a word, which seems to be a misunderstanding of the context. This is a step-by-step instruction in a list and does not constitute a typo.- 85-85: The phrase "Compute
V' += P.Amount2. ComputeCT += P.Length" is flagged for repeating a word, which seems to be a misunderstanding of the context. This is a step-by-step instruction in a list and does not constitute a typo.- 215-215: The phrase "1/4 of tokens vesting each quarter" might be missing an article before "tokens." However, this seems to be a stylistic choice rather than a grammatical error, as the sentence is clear and understandable in its current form.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 8
Configuration used: .coderabbit.yml
Files selected for processing (1)
- x/accounts/defaults/lockup/README.md (1 hunks)
Path instructions used (1)
x/accounts/defaults/lockup/README.md (1)
**/*.md
Assess the documentation for misspellings, grammatical errors, missing documentation and correctness
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Review Status
Actionable comments generated: 7
Configuration used: .coderabbit.yml
Files selected for processing (1)
- x/accounts/defaults/lockup/README.md (1 hunks)
Path instructions used (1)
x/accounts/defaults/lockup/README.md (1)
**/*.md
Assess the documentation for misspellings, grammatical errors, missing documentation and correctness
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: .coderabbit.yml
Files selected for processing (1)
- x/accounts/defaults/lockup/README.md (1 hunks)
Path instructions used (1)
x/accounts/defaults/lockup/README.md (1)
**/*.md
Assess the documentation for misspellings, grammatical errors, missing documentation and correctness
Additional comments (6)
x/accounts/defaults/lockup/README.md (6)
- 1-1: The title "Lockup Accounts" might be more accurately represented as "Lockup Accounts" to maintain consistency with the module naming convention and improve readability.
- 41-41: The term "enddate" should be two words. Consider revising to "end date" for correctness.
- 73-73: Consider adding a comma after "periods" for clarity and grammatical correctness.
- 99-99: The term "permentally" seems to be a typo. Consider correcting it to "permanently" for accuracy.
- 159-159: Consider adding a comma after "anymore" for clarity and grammatical correctness.
- 160-160: Consider adding a comma before "however" for clarity and grammatical correctness.
julienrbrt
changed the title
julienrbrt
changed the title
There was a problem hiding this comment.
Actionable comments posted: 0
Review Status
Configuration used: .coderabbit.yml
Files selected for processing (1)
- x/accounts/defaults/lockup/README.md (1 hunks)
Additional Context Used
Path-based Instructions (1)
x/accounts/defaults/lockup/README.md (1)
**/*.md:
Assess the documentation for misspellings, grammatical errors, missing documentation and correctness
Additional comments not posted (6)
x/accounts/defaults/lockup/README.md (6)
1-1: The title "Lockup Accounts" might be more accurately represented as "Lockup Accounts" to maintain consistency with the module naming convention and improve readability.
22-22: The term "enddate" should be two words. Consider revising to "end date" for correctness.
73-73: Consider adding a comma after "periods" for clarity and grammatical correctness.
99-99: The term "permentally" seems to be a typo. Consider correcting it to "permanently" for accuracy.
160-160: Consider adding a comma after "anymore" for clarity and grammatical correctness.
160-160: Consider adding a comma before "however" for clarity and grammatical correctness.
There was a problem hiding this comment.
Actionable comments posted: 4
Review Status
Configuration used: .coderabbit.yml
Files selected for processing (1)
- x/accounts/defaults/lockup/README.md (1 hunks)
Additional Context Used
Path-based Instructions (1)
x/accounts/defaults/lockup/README.md (1)
**/*.md:
Assess the documentation for misspellings, grammatical errors, missing documentation and correctness
Additional comments not posted (8)
x/accounts/defaults/lockup/README.md (8)
1-1: The title "Lockup Accounts" might be more accurately represented as "Lockup Accounts" to maintain consistency with the module naming convention and improve readability.
22-22: There are extra spaces before "account." Consider removing the extra spaces for consistency and readability.
41-41: The term "enddate" should be two words. Consider revising to "end date" for correctness.
73-73: Consider adding a comma after "periods" for clarity and grammatical correctness.
99-99: The term "permentally" seems to be a typo. Consider correcting it to "permanently" for accuracy.
160-160: Consider adding a comma after "anymore" for clarity and grammatical correctness.
160-160: Consider adding a comma before "however" for clarity and grammatical correctness.
51-51: The unpaired symbol'inV'might confuse readers. Ensure consistency in the use of symbols for variables.Consider using a consistent notation for variables throughout the documentation to avoid confusion.
| * [Slashing](#slashing) | ||
| * [Periodic Lockup](#periodic-lockup) | ||
|
|
||
| The x/accounts/defaults/lockup module provides the implementation for lockup accounts within the x/accounts module. |
There was a problem hiding this comment.
The introduction sentence could be enhanced for clarity and conciseness. Consider rephrasing to directly state the purpose of the module.
- The x/accounts/defaults/lockup module provides the implementation for lockup accounts within the x/accounts module.
+ The `x/accounts/defaults/lockup` module implements lockup account functionalities within the Cosmos SDK's `x/accounts` module.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| The x/accounts/defaults/lockup module provides the implementation for lockup accounts within the x/accounts module. | |
| The `x/accounts/defaults/lockup` module implements lockup account functionalities within the Cosmos SDK's `x/accounts` module. |
| To determine the amount of coins that are vested for a given block time `T`, the | ||
| following is performed: | ||
|
|
||
| 1. Compute `X := T - StartTime` |
There was a problem hiding this comment.
The phrase "Compute Compute" appears to be duplicated in the documentation. This seems to be a typo or copy-paste error.
- 1. Compute `X := T - StartTime`
+ 1. Compute `X := T - StartTime`Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 1. Compute `X := T - StartTime` | |
| 1. Compute `X := T - StartTime` |
x/accounts/defaults/lockup/README.md
Outdated
|
|
||
| The periodic vesting account locks tokens for a series of periods. The account can receive coins and send coins. After all the periods, all the coins are unlocked and the account can send coins. | ||
|
|
||
| Periodic vesting accounts require calculating the coins released during each period for a given block time `T`. Note that multiple periods could have passed when calling `GetVestedCoins`, so we must iterate over each period until the end of that period is after `T`. |
There was a problem hiding this comment.
The phrase "could have passed" might be missing a preposition. Consider rephrasing for clarity.
- Note that multiple periods could have passed when calling `GetVestedCoins`, so we must iterate over each period until the end of that period is after `T`.
+ Note that multiple periods could have elapsed by the time `GetVestedCoins` is called, necessitating iteration over each period until finding one that ends after `T`.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Periodic vesting accounts require calculating the coins released during each period for a given block time `T`. Note that multiple periods could have passed when calling `GetVestedCoins`, so we must iterate over each period until the end of that period is after `T`. | |
| Periodic vesting accounts require calculating the coins released during each period for a given block time `T`. Note that multiple periods could have elapsed by the time `GetVestedCoins` is called, necessitating iteration over each period until finding one that ends after `T`. |
x/accounts/defaults/lockup/README.md
Outdated
|
|
||
| ### BaseLockup | ||
|
|
||
| The base vesting account is used by all default lockup accounts. It contains the basic information for a vesting account. The Base vesting account keeps knowledge of the staking delegations from the account. |
There was a problem hiding this comment.
Should we capitalise the B to keep it consistent?
|
|
||
| <!--- TODO: need to expand more on this ---> | ||
|
|
There was a problem hiding this comment.
Consider removing the extra blank line for better formatting consistency.
- Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * [Lockup Account Types](#lockup-account-types) | ||
| * [BaseLockup](#baselockup) | ||
| * [ContinuousLockup](#continuouslockup) | ||
| * [DelayedLockup](#delayedlockup) | ||
| * [PeriodicLockup](#periodiclockup) | ||
| * [PermanentLocked](#permanentlocked) | ||
| * [Genesis Initialization](#genesis-initialization) | ||
| * [Examples](#examples) | ||
| * [Simple](#simple) | ||
| * [Slashing](#slashing) | ||
| * [Periodic Lockup](#periodic-lockup) |
There was a problem hiding this comment.
Adjust the indentation of the unordered list items to align with Markdown best practices.
- * [BaseLockup](#baselockup)
- * [ContinuousLockup](#continuouslockup)
- * [DelayedLockup](#delayedlockup)
- * [PeriodicLockup](#periodiclockup)
- * [PermanentLocked](#permanentlocked)
+ * [BaseLockup](#baselockup)
+ * [ContinuousLockup](#continuouslockup)
+ * [DelayedLockup](#delayedlockup)
+ * [PeriodicLockup](#periodiclockup)
+ * [PermanentLocked](#permanentlocked)Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * [Lockup Account Types](#lockup-account-types) | |
| * [BaseLockup](#baselockup) | |
| * [ContinuousLockup](#continuouslockup) | |
| * [DelayedLockup](#delayedlockup) | |
| * [PeriodicLockup](#periodiclockup) | |
| * [PermanentLocked](#permanentlocked) | |
| * [Genesis Initialization](#genesis-initialization) | |
| * [Examples](#examples) | |
| * [Simple](#simple) | |
| * [Slashing](#slashing) | |
| * [Periodic Lockup](#periodic-lockup) | |
| * [Lockup Account Types](#lockup-account-types) | |
| * [BaseLockup](#baselockup) | |
| * [ContinuousLockup](#continuouslockup) | |
| * [DelayedLockup](#delayedlockup) | |
| * [PeriodicLockup](#periodiclockup) | |
| * [PermanentLocked](#permanentlocked) | |
| * [Genesis Initialization](#genesis-initialization) | |
| * [Examples](#examples) | |
| * [Simple](#simple) | |
| * [Slashing](#slashing) | |
| * [Periodic Lockup](#periodic-lockup) |
| The x/accounts/defaults/lockup module provides the implementation for lockup accounts within the x/accounts module. | ||
|
|
||
| ## Lockup Account Types | ||
|
|
||
| ### BaseLockup | ||
|
|
||
| The base lockup account is used by all default lockup accounts. It contains the basic information for a lockup account. The Base lockup account keeps knowledge of the staking delegations from the account. |
There was a problem hiding this comment.
Enhance the introduction sentence for clarity and conciseness.
- The x/accounts/defaults/lockup module provides the implementation for lockup accounts within the x/accounts module.
+ The `x/accounts/defaults/lockup` module implements lockup account functionalities within the Cosmos SDK's `x/accounts` module.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| The x/accounts/defaults/lockup module provides the implementation for lockup accounts within the x/accounts module. | |
| ## Lockup Account Types | |
| ### BaseLockup | |
| The base lockup account is used by all default lockup accounts. It contains the basic information for a lockup account. The Base lockup account keeps knowledge of the staking delegations from the account. | |
| The `x/accounts/defaults/lockup` module implements lockup account functionalities within the Cosmos SDK's `x/accounts` module. | |
| ## Lockup Account Types | |
| ### BaseLockup | |
| The base lockup account is used by all default lockup accounts. It contains the basic information for a lockup account. The Base lockup account keeps knowledge of the staking delegations from the account. |
|
|
||
| ### BaseLockup | ||
|
|
||
| The base lockup account is used by all default lockup accounts. It contains the basic information for a lockup account. The Base lockup account keeps knowledge of the staking delegations from the account. |
There was a problem hiding this comment.
Remove extra spaces before "account" for consistency and readability.
- The Base lockup account keeps knowledge of the staking delegations from the account.
+ The Base lockup account keeps knowledge of the staking delegations from the account.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| The base lockup account is used by all default lockup accounts. It contains the basic information for a lockup account. The Base lockup account keeps knowledge of the staking delegations from the account. | |
| The base lockup account is used by all default lockup accounts. It contains the basic information for a lockup account. The Base lockup account keeps knowledge of the staking delegations from the account. |
| ```go | ||
| type BaseLockup struct { | ||
| // Owner is the address of the account owner. | ||
| Owner collections.Item[[]byte] | ||
| OriginalLocking collections.Map[string, math.Int] | ||
| DelegatedFree collections.Map[string, math.Int] | ||
| DelegatedLocking collections.Map[string, math.Int] | ||
| WithdrawedCoins collections.Map[string, math.Int] | ||
| addressCodec address.Codec | ||
| headerService header.Service | ||
| // lockup end time. | ||
| EndTime collections.Item[time.Time] | ||
| } |
There was a problem hiding this comment.
Replace tabs with spaces in the Go code snippet to maintain consistency and readability in the documentation.
- // Owner is the address of the account owner.
- Owner collections.Item[[]byte]
- OriginalLocking collections.Map[string, math.Int]
- DelegatedFree collections.Map[string, math.Int]
- DelegatedLocking collections.Map[string, math.Int]
- WithdrawedCoins collections.Map[string, math.Int]
- addressCodec address.Codec
- headerService header.Service
- // lockup end time.
- EndTime collections.Item[time.Time]
+ // Owner is the address of the account owner.
+ Owner collections.Item[[]byte]
+ OriginalLocking collections.Map[string, math.Int]
+ DelegatedFree collections.Map[string, math.Int]
+ DelegatedLocking collections.Map[string, math.Int]
+ WithdrawedCoins collections.Map[string, math.Int]
+ addressCodec address.Codec
+ headerService header.Service
+ // lockup end time.
+ EndTime collections.Item[time.Time]Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ```go | |
| type BaseLockup struct { | |
| // Owner is the address of the account owner. | |
| Owner collections.Item[[]byte] | |
| OriginalLocking collections.Map[string, math.Int] | |
| DelegatedFree collections.Map[string, math.Int] | |
| DelegatedLocking collections.Map[string, math.Int] | |
| WithdrawedCoins collections.Map[string, math.Int] | |
| addressCodec address.Codec | |
| headerService header.Service | |
| // lockup end time. | |
| EndTime collections.Item[time.Time] | |
| } | |
| type BaseLockup struct { | |
| // Owner is the address of the account owner. | |
| Owner collections.Item[[]byte] | |
| OriginalLocking collections.Map[string, math.Int] | |
| DelegatedFree collections.Map[string, math.Int] | |
| DelegatedLocking collections.Map[string, math.Int] | |
| WithdrawedCoins collections.Map[string, math.Int] | |
| addressCodec address.Codec | |
| headerService header.Service | |
| // lockup end time. | |
| EndTime collections.Item[time.Time] | |
| } |
| type ContinuousLockingAccount struct { | ||
| *BaseLockup | ||
| StartTime collections.Item[time.Time] | ||
| } |
There was a problem hiding this comment.
Replace tabs with spaces in the Go code snippet for the ContinuousLockingAccount struct to maintain consistency and readability.
- *BaseLockup
- StartTime collections.Item[time.Time]
+ *BaseLockup
+ StartTime collections.Item[time.Time]Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| type ContinuousLockingAccount struct { | |
| *BaseLockup | |
| StartTime collections.Item[time.Time] | |
| } | |
| type ContinuousLockingAccount struct { | |
| *BaseLockup | |
| StartTime collections.Item[time.Time] | |
| } |
| type DelayedLockingAccount struct { | ||
| *BaseLockup | ||
| } |
There was a problem hiding this comment.
Replace tabs with spaces in the Go code snippet for the DelayedLockingAccount struct to maintain consistency and readability.
- *BaseLockup
+ *BaseLockupCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| type DelayedLockingAccount struct { | |
| *BaseLockup | |
| } | |
| type DelayedLockingAccount struct { | |
| *BaseLockup | |
| } |
| type PeriodicLockingAccount struct { | ||
| *BaseLockup | ||
| StartTime collections.Item[time.Time] | ||
| LockingPeriods collections.Vec[lockuptypes.Period] |
There was a problem hiding this comment.
Replace tabs with spaces in the Go code snippet for the PeriodicLockingAccount struct to maintain consistency and readability.
- *BaseLockup
- StartTime collections.Item[time.Time]
- LockingPeriods collections.Vec[lockuptypes.Period]
+ *BaseLockup
+ StartTime collections.Item[time.Time]
+ LockingPeriods collections.Vec[lockuptypes.Period]Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| type PeriodicLockingAccount struct { | |
| *BaseLockup | |
| StartTime collections.Item[time.Time] | |
| LockingPeriods collections.Vec[lockuptypes.Period] | |
| type PeriodicLockingAccount struct { | |
| *BaseLockup | |
| StartTime collections.Item[time.Time] | |
| LockingPeriods collections.Vec[lockuptypes.Period] |
| type PermanentLockingAccount struct { | ||
| *BaseLockup | ||
| } |
There was a problem hiding this comment.
Replace tabs with spaces in the Go code snippet for the PermanentLocked struct to maintain consistency and readability.
- *BaseLockup
+ *BaseLockupCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| type PermanentLockingAccount struct { | |
| *BaseLockup | |
| } | |
| type PermanentLockingAccount struct { | |
| *BaseLockup | |
| } |
| ``` | ||
|
|
||
| 6. Sends 2 coins. At this point, the account cannot send anymore until further | ||
| coins vest or it receives additional coins. It can still, however, delegate. |
There was a problem hiding this comment.
Use a comma before "or" if it connects two independent clauses (unless they are closely connected and short).
- At this point, the account cannot send anymore until further coins vest or it receives additional coins.
+ At this point, the account cannot send anymore until further coins vest, or it receives additional coins.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| coins vest or it receives additional coins. It can still, however, delegate. | |
| coins vest, or it receives additional coins. It can still, however, delegate. |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Description
add docs to the lockup accounts
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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
Summary by CodeRabbit
x/accounts/lockupmodule toLockup Accounts.BaseLockup,ContinuousLockup,DelayedLockup,PeriodicLockup, andPermanentLocked.