fix: fix some logics and sync spec to latest source code #18

zsystm · 2023-07-24T05:55:09Z

Description

Closes: docs: full sync spec with latest code #13
Closes: feat: financial sync #16
Closes: update: events type #17

Fixed

I found some logical errors during syncing spec to latest source codes.

DoCancelProvideInsurance

when cancel provide insurance, we should return all of its spendable coins from both derived address and fee pool address.

DoWithdrawInsurance

we should accept withdrawal request for only paired or unpaired insurances, not unpairing insurance. It because unpairing insurance is already in state transition situation at epoch, so it's weird to queue the request for that insurance.

GetAllRePairableChunksAndOutInsurances

if paired insurance of paired chunk have invalid insurance, then unpairing it and add it to out insurances to hande just like other unpairing chunks.
there was a logical error because chunk's status is changed to unpairing but, current paired chunk's status is still Paired and chunk have paired insurance id even if it is unpairing chunk.

add missing invariant checks

newly added RedelegationInfosInvariant was not included

Updated

calculation of NetAmount

consider insurance balance if there are any slashing penalty.

calculation of TotalRemainingRewards

dynamic fee and discounted reward mechanism were introduced before. we need to consider this when calc remaining rewards.
before: del_reward - insurance_commission
after:

rest = del_reward - insurance_commission
remaining = rest x (1 - dynamic_fee_rate)

Chore

refactor variables name in invariants.go
use lsm's own event key types, not other module's.
add module name to each event

Docs

Updated docs related with NetAmount.

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...

targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
included the necessary unit and integration tests
reviewed "Files changed" and left comments if necessary

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 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)

DoCancelProvideInsurance when cancel provide insurance, we should return all of its spendable coins from both derived address and fee pool address. DoWithdrawInsurance we can accept request only paired or unpaired insurances, not unpairing insurance. it because unpairing insurance is already in state transition situation at epoch, so its weird to queue the request for that insurance.

fix core logics before: * there can be bug because chunk's status is changed to unpairing but, current paired chunk's status is still Paired and chunk have paired insurance id even if it is unpairing chunk. after: if paired insurance of paired chunk have invalid insurance, then unpairing it and add it to out insurances to hande just like other unpairing chunks. add missing invariant checks * newly added RedelegationInfosInvariant was not included chore * refactor variables name in invariants.go * use lsm's own event key types, not other module's. * add module name to each event

dongsam

The 5.75% (double_sign_friction + down_time_friction) notation on the spec is guaranteed only when param change is limited through the antihandler, so the antihandler content on spec needs to be updated

chore: since pb.go has been modified, re-generation of swagger and statik is needed

x/liquidstaking/spec/02_state.md

also updated swagger docs and statik

* if there were slashing (token value of chunk's del < chunk size), then we consider insurance balance now. * remove NativeTokenToLiquidStakeToken, just use MintRate. it is more easy to understand.

x/liquidstaking/keeper/net_amount.go

x/liquidstaking/spec/02_state.md

* add description about utilization ratio * definition of NetAmount is changed. we consider insurance coverage now. * add missing item to a formula of NetAmount: sum of all unbonding balance of chunks (insurance coverage included) * MaximumDiscountRate is defined as governance parameter

zsystm · 2023-07-27T02:11:53Z

@dongsam @poorphd
Hey guys. Based on yesterday discussions, I updated the spec in 82516ac.
Could you review this commit?

After updated spec is confirmed, I'll apply it in source codes.

x/liquidstaking/spec/02_state.md

dongsam · 2023-07-27T02:19:36Z

x/liquidstaking/spec/01_concepts.md

@@ -76,4 +77,4 @@ The rewards accumulated on the **reward module account** can be withdrawn by any

 The discount rate is calculated as follows: `discount rate = reward module account's balance / (num paired chunks * chunk size)`


we discussed the discount rate need to fix to use NetAmount instead of num-paired chunks, like the utilization ratio

Oh, I'll update it soon. sorry for miss

Updated! thanks. 2fd453d

@dongsam
Any additional comments for this?

LGTM, now we can proceed with the code update based on the updated spec

chore: Transition Diagram png files seem to be missing
forum post also should be updated

@dongsam @poorphd
I think I should add description of security cap for both HardCap and MaximumDiscountRate.
Let me add these contents also.

Added missing diagrams and contents for security cap in d1733cc

Now I'll proceed the code updates.

the update LGTM as well

TODO: fix broken tests

zsystm · 2023-07-28T07:38:32Z

@dongsam @poorphd

I updated source codes based on updated spec.
b-harvest:990c31c^^^^^...b-harvest:990c31c

Please review file changes from several commits 🙏

x/liquidstaking/keeper/liquidstaking.go

x/liquidstaking/types/params_test.go

those functions are moved to type level functions

x/liquidstaking/keeper/liquidstaking.go

dongsam

LGTM!

zsystm added 4 commits July 24, 2023 14:42

sync state.md with latest implementation

7c0d133

update state transition diagrams

6e03a41

zsystm self-assigned this Jul 24, 2023

zsystm requested review from dongsam and poorphd July 24, 2023 06:02

dongsam requested changes Jul 24, 2023

View reviewed changes

x/liquidstaking/spec/02_state.md Outdated Show resolved Hide resolved

zsystm added 7 commits July 24, 2023 17:55

add detailed comments for net amount and param change ante handlers

8f5b2c4

also updated swagger docs and statik

add missed swagger yaml

0d5e8ae

add description for 5.75%

71fcb97

remove ConservativeNetAmount and update calc method of TotalLiquidTokens

d6ed3cf

* if there were slashing (token value of chunk's del < chunk size), then we consider insurance balance now. * remove NativeTokenToLiquidStakeToken, just use MintRate. it is more easy to understand.

update remaining reward calc method

f74fd46

chore: update name of tc

e95dedb

update spec

428a82e

zsystm requested a review from dongsam July 25, 2023 06:00

dongsam requested changes Jul 25, 2023

View reviewed changes

x/liquidstaking/keeper/net_amount.go Outdated Show resolved Hide resolved

x/liquidstaking/spec/02_state.md Show resolved Hide resolved

zsystm added 4 commits July 25, 2023 16:04

optimize operations

5c8ee8c

optimize redundant calls

3255774

add todo

81480d5

chore: fix grammar

f7cb028

dongsam requested changes Jul 27, 2023

View reviewed changes

zsystm added 6 commits July 27, 2023 11:31

update formula for calculating discount rate

2fd453d

add missing diagrams and security cap description

d1733cc

wip: update and refactor net amount state part

a7ccafb

TODO: fix broken tests

fix broken tcs and refactor some functions

fec0e74

remove netAmountBeforeModuleFee from net amount state

9f6deec

remove un-used function

a660689

add NetAmountBeforeModuleFee at spec

990c31c

chore: fix variable name

be23323

zsystm requested a review from dongsam July 31, 2023 01:04

dongsam reviewed Jul 31, 2023

View reviewed changes

x/liquidstaking/keeper/liquidstaking.go Outdated Show resolved Hide resolved

x/liquidstaking/types/params_test.go Outdated Show resolved Hide resolved

zsystm added 2 commits July 31, 2023 13:00

refactor: calc functions / add: dynamic fee tcs

6d3baec

those functions are moved to type level functions

add custom stringer for Params

b00c468

zsystm requested a review from dongsam July 31, 2023 04:58

add tc for CalcUtilizationRatio / chore: fix number expression

7ffbc4d

dongsam requested changes Jul 31, 2023

View reviewed changes

x/liquidstaking/keeper/liquidstaking.go Outdated Show resolved Hide resolved

x/liquidstaking/keeper/liquidstaking.go Outdated Show resolved Hide resolved

remove redundant func and logic

0dd2510

dongsam self-requested a review July 31, 2023 06:07

dongsam approved these changes Jul 31, 2023

View reviewed changes

zsystm merged commit 60a80bf into liquidstaking-module Jul 31, 2023
9 checks passed

zsystm mentioned this pull request Aug 9, 2023

Canto Core Devs Meeting 7 Agenda Canto-Network/pm#7

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: fix some logics and sync spec to latest source code #18

fix: fix some logics and sync spec to latest source code #18

zsystm commented Jul 24, 2023 •

edited

Loading

dongsam left a comment •

edited

Loading

zsystm commented Jul 27, 2023

dongsam Jul 27, 2023

zsystm Jul 27, 2023

zsystm Jul 27, 2023 •

edited

Loading

zsystm Jul 27, 2023

dongsam Jul 27, 2023

dongsam Jul 27, 2023 •

edited

Loading

zsystm Jul 27, 2023 •

edited

Loading

zsystm Jul 27, 2023

poorphd Jul 27, 2023

zsystm commented Jul 28, 2023

dongsam left a comment

		@@ -76,4 +77,4 @@ The rewards accumulated on the reward module account can be withdrawn by any

		The discount rate is calculated as follows: `discount rate = reward module account's balance / (num paired chunks * chunk size)`

fix: fix some logics and sync spec to latest source code #18

fix: fix some logics and sync spec to latest source code #18

Conversation

zsystm commented Jul 24, 2023 • edited Loading

Description

Fixed

Updated

Chore

Docs

Author Checklist

Reviewers Checklist

dongsam left a comment • edited Loading

Choose a reason for hiding this comment

zsystm commented Jul 27, 2023

dongsam Jul 27, 2023

Choose a reason for hiding this comment

zsystm Jul 27, 2023

Choose a reason for hiding this comment

zsystm Jul 27, 2023 • edited Loading

Choose a reason for hiding this comment

zsystm Jul 27, 2023

Choose a reason for hiding this comment

dongsam Jul 27, 2023

Choose a reason for hiding this comment

dongsam Jul 27, 2023 • edited Loading

Choose a reason for hiding this comment

zsystm Jul 27, 2023 • edited Loading

Choose a reason for hiding this comment

zsystm Jul 27, 2023

Choose a reason for hiding this comment

poorphd Jul 27, 2023

Choose a reason for hiding this comment

zsystm commented Jul 28, 2023

dongsam left a comment

Choose a reason for hiding this comment

zsystm commented Jul 24, 2023 •

edited

Loading

dongsam left a comment •

edited

Loading

zsystm Jul 27, 2023 •

edited

Loading

dongsam Jul 27, 2023 •

edited

Loading

zsystm Jul 27, 2023 •

edited

Loading