fix: bugs discovered during simulation #31

zsystm · 2023-08-09T04:18:52Z

Fixes

add missing genesis state RedelegationInfo
remove del shares checking in ChunkInvariantsCheck
- shares can be decreased (e.g. Slashing during ReDelegation)
fix wrong implementation of RedelegationInfo.Matured
- it was reversed. must check based on currTime.
- at some time, currTime will pass the rinfo.CompletionTime, then it should return true but formal implementation will return false.
fix RePairRankedInsurances logic
- outIns from restOutInsurances can be Paired.
- fix fix: wrong status check when re-pair chunk and insurance #28
fix fix: negative penaltyAmt #26
fix fix: broken staking module invariants #27
- when do mustPairChunkAndDelegate, must use latest Validator state.
fix buggy sim operations (e.g. SimulateMsgProvideInsurance)

Gas Optimization

separate InsuranceState which will be used when query states of module

SPEC

add description for InsuranceState

Simulation

implement operations of lsm
return noOps in expected error situations
applied PowerReduction 10^6
applied static genesis and params (same with Mainnet)
update weights (more LiquidUnstake and ClaimDiscountedReward)
(temp) applied PowerReduction 10^6 when calc epoch mint provision

Dependency

(temp) replace cosmos-sdk to https://github.com/b-harvest/cosmos-sdk/releases/tag/v0.45.9-canto-lsm-sim to run lsm simulation successfully.

Refactoring

move advance epoch logic to app module level

Description

Closes: #XXXX

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

todo: need to run it in local

TODO: Solve cycle problem

TODO: deal with staking module's initial stake part

…m/simulation-advance-epoch # Conflicts: # app/params/weights.go # proto/canto/liquidstaking/v1/liquidstaking.proto # x/liquidstaking/keeper/liquidstaking.go # x/liquidstaking/simulation/proposals.go # x/liquidstaking/spec/02_state.md # x/liquidstaking/spec/chunk_state_transition_diagram.png # x/liquidstaking/spec/insurance_state_transition_diagram.png # x/liquidstaking/types/liquidstaking.pb.go

del shares can be less than 250K (e.g. slashing during re-delegation period, not yet reached epoch)

now chunk invariants does not check its delegation shares. it can be changed by slashing during re-delegation.

decision must be based on current block time. if current block time >= info.CompletionTime, then it is matured. if not, it is un-matured.

disabled mimicking begin block logic of distribution module at epoch

target insurance must be pairing

must use validator retrieved from latest state.

EpochInfo.CurrentEpochStartHeight is set to the block height at the time of init genesis. This state is changeable when export and import, so exclude it.

when ins directs Unbonding validator, then this situation can happen. In this situation, we just unpair and undelegate it.

* fix dynamic fee rate as default

this is related with recent patch. outIns is already unpairing for unpairing_for_withdrawa, so we must not update it. chore: removed un-used method.

out insurance can be PAIRED status (ranked out but no replacement). if it is not unpairing or unpairing for withdrawal we must change its status to unpairing because unbonding will be started.

when decide unstakable chunk, we should consider whether it is already queued or not.

optimize gas consumption * added new internal state InsuranceState * when calc NetAmount we don't need insurance states. so separate that state which will be used when query. update sim * apply default genesis * don't allow param change * enable inflation module temp: apply sdk.DefaultPowerReduction when calc epoch provision. this will be changed at next PR

x/liquidstaking/types/redelegation_info_test.go

dongsam · 2023-08-09T05:48:53Z

x/liquidstaking/keeper/grpc_query.go

+	return &types.QueryStatesResponse{
+		NetAmountState: nas,
+		InsuranceState: is,
+	}, nil


If the endpoint corresponds to the API being used on the dashboard that has already been delivered to the frontend development team, it is not good to have a breaking change, so it will need to be reviewed was the endpoint already in use on the dashboard page

Thanks for the feedback. Frontend team already applied formal endpoints in here.

How about creating a PR related with this change for them? I can do it and need no much time.

I don't think it's necessary to change the response struct due to refactor for internal logic, it's better to update it at once when future modifications are inevitable

If they are already using it, use the internal getter function that has been refactored, but as a result, 'QueryStatesResponse' would be better to use the existing structure as it is

I added NetAmountStateEssentials which is used by all core logics of lsm.

NetAmountState is used just for query and testing.
When call GetNetAmountState it calls GetNetAmountStateEssentials internally and use that result to create struct.

Changes: b-harvest:e47ac8^^...b-harvest:e47ac8

@dongsam
If you are ok with changes, I'll update the spec too. SPEC is not updated yet.

Yeah, that part is looks good. Let's continue with the power reduction part

Updated spec in here 04d03d3

dongsam · 2023-08-09T06:03:14Z

app/sim_test.go

@@ -308,6 +315,7 @@ func TestAppStateDeterminism(t *testing.T) {
 }

 func TestAppSimulationAfterImport(t *testing.T) {
+	liquidstakingtypes.ChunkSize = sdk.TokensFromConsensusPower(250_000, sdk.DefaultPowerReduction)


This part can be removed because it is already being done in init()

dongsam · 2023-08-09T06:04:35Z

app/sim_test.go

 		// {app.keys[erc20types.StoreKey], newApp.keys[erc20types.StoreKey], [][]byte{}},
-		//{app.keys[epochstypes.StoreKey], newApp.keys[epochstypes.StoreKey], [][]byte{}},
+		{app.keys[epochstypes.StoreKey], newApp.keys[epochstypes.StoreKey], [][]byte{


It should be commented, Ref

done in https://github.com/Canto-Network/Canto/blob/main/app/sim_test.go#L218-L219

comment is written by myself but will use comment you linked when merge main branch.

dongsam · 2023-08-09T06:05:29Z

app/params/weights.go

 	DefaultWeightUpdateDynamicFeeRateProposal int = 2
 	DefaultWeightUpdateMaximumDiscountRate        = 2
+	DefaultWeightAdvanceEpoch                 int = 5


Unused weight variables

done in a9b2103

dongsam · 2023-08-09T06:07:21Z

app/app.go

+	baseKeeper := bankkeeper.NewBaseKeeper(
 		appCodec, keys[banktypes.StoreKey], app.AccountKeeper, app.GetSubspace(banktypes.ModuleName), app.BlockedAddrs(),
 	)
+	app.BankKeeper = baseKeeper


Is there a reason or intention to do this?

I think we can delete it. Done in 781a833.

dongsam · 2023-08-09T06:07:57Z

x/inflation/types/inflation_calculation.go

@@ -42,6 +40,6 @@ func CalculateEpochMintProvision(
 	// Multiply epochMintProvision with power reduction (10^18 for evmos) as the
 	// calculation is based on `evmos` and the issued tokens need to be given in
 	// `aevmos`
-	epochProvision = epochProvision.Mul(ethermint.PowerReduction.ToDec())
+	epochProvision = epochProvision.Mul(sdk.DefaultPowerReduction.ToDec())


This part needs to be reverted before the PR merges

more understandable and readable tc

…State)

epoch module's state can be changed when initGenesis.

all core logics using NetAmount before now use NetAmountEssentials. NetAmount is used just for querying.

dongsam · 2023-08-10T06:27:01Z

In order to solve the power reduction issue I mentioned yesterday, I think the reduction modification in canto should be reverted to ethermint and revised from sdk simulation to big int

zsystm · 2023-08-10T06:29:38Z

In order to solve the power reduction issue I mentioned yesterday, I think the reduction modification in canto should be reverted to ethermint and revised from sdk simulation to big int

Yeah definitely we need to do that. I started that work after requesting your review for NetAmountStateEssential part.

During your review for updated codes, I'll handle that.

for this, applied custom ibc-go and cosmos-sdk to updated initialStake as sdk.Int

zsystm · 2023-08-10T08:06:28Z

@dongsam
Applied ethermint reduction! bed5d90

For this, I used b-harvest ibc-go and cosmos-sdk.

dongsam · 2023-08-10T08:44:23Z

@dongsam

Applied ethermint reduction! bed5d90

For this, I used b-harvest ibc-go and cosmos-sdk.

Could you check the failed workflow?

zsystm · 2023-08-10T09:49:58Z

Sure! I fixed it. Thanks!

dongsam

LGTM, let's proceed additionally with the gas optimization, NetAmountState structure, and customizing sdk simulation parts in separate issues after upstream rebase/merge

zsystm added 30 commits July 24, 2023 14:42

sync state.md with latest implementation

7c0d133

update state transition diagrams

6e03a41

wip: refactor simulation codes

6d9e6a0

todo: need to run it in local

fix and update app.go

4513cf7

wip: implementing proposal simulations

6de9b56

TODO: Solve cycle problem

solve import cycle and make it work

c00b58c

TODO: deal with staking module's initial stake part

fix simulations

6322bf6

update reduction

ef8cb94

resolve errors after merge

0263428

fix epoch and wrong deduction reduce advance epoch weight

2aa2462

update invariant and refactor some codes

1276983

del shares can be less than 250K (e.g. slashing during re-delegation period, not yet reached epoch)

remove un-used check and add more context to panic message

d69186e

now chunk invariants does not check its delegation shares. it can be changed by slashing during re-delegation.

fix: re-delegation matured logic

b7e877f

decision must be based on current block time. if current block time >= info.CompletionTime, then it is matured. if not, it is un-matured.

wip: fix some isseus and trouble shooting for seed 1623992154303935393

e400e88

disabled mimicking begin block logic of distribution module at epoch

fix: simulation cancel provide insurance

be9504b

target insurance must be pairing

fix negative penaltyAmt

fae5123

sim: change power reduction

cdeac2f

fix: not updated validator problem and power reduction

6cdfeb7

must use validator retrieved from latest state.

exclude epochs key

e2cdcae

EpochInfo.CurrentEpochStartHeight is set to the block height at the time of init genesis. This state is changeable when export and import, so exclude it.

fix: missing ReDelegationInfo at genesis import and export

2a9b63f

chore: fix wrong variable name

cfb616f

fix: restOutIns can have paired chunk

c1f8596

when ins directs Unbonding validator, then this situation can happen. In this situation, we just unpair and undelegate it.

temp: disable lsm param change

13003eb

* fix dynamic fee rate as default

fix: out insurance's status must not be updated

9e82ef0

this is related with recent patch. outIns is already unpairing for unpairing_for_withdrawa, so we must not update it. chore: removed un-used method.

fix: out insurance status

b7da931

out insurance can be PAIRED status (ranked out but no replacement). if it is not unpairing or unpairing for withdrawal we must change its status to unpairing because unbonding will be started.

fix: simop liquid unstake

fabb46f

when decide unstakable chunk, we should consider whether it is already queued or not.

zsystm self-assigned this Aug 9, 2023

zsystm added 2 commits August 9, 2023 13:36

add missing files

335d028

use b-harvest cosmos-sdk patched for canto-lsm simulation testing

eb034c0

zsystm marked this pull request as ready for review August 9, 2023 05:26

zsystm requested a review from dongsam August 9, 2023 06:07

dongsam reviewed Aug 9, 2023

View reviewed changes

clarify tc

5b6759d

more understandable and readable tc

zsystm mentioned this pull request Aug 9, 2023

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

Closed

zsystm added 7 commits August 10, 2023 10:21

add missing proto file (separate insurance related field as Insurance…

6a5555f

…State)

remove un-used weights

a9b2103

refactor: just assign base keeper to BankKeeper right away

781a833

add missing proto file

72d2a68

remove epoch infos keys

58a181b

epoch module's state can be changed when initGenesis.

roll-back change and add NetAmountStateEssentials

29125c1

all core logics using NetAmount before now use NetAmountEssentials. NetAmount is used just for querying.

add missing files

e47ac8d

zsystm requested a review from dongsam August 10, 2023 06:09

apply ethermint reduction

bed5d90

for this, applied custom ibc-go and cosmos-sdk to updated initialStake as sdk.Int

update spec related to NetAmountStateEssentials

04d03d3

fix syntax error(should use sdk.Int)

e9b728d

dongsam approved these changes Aug 10, 2023

View reviewed changes

zsystm merged commit d39e530 into liquidstaking-module Aug 11, 2023
9 checks passed

zsystm linked an issue Aug 11, 2023 that may be closed by this pull request

feat: advance epoch in simulation #14

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: bugs discovered during simulation #31

fix: bugs discovered during simulation #31

zsystm commented Aug 9, 2023 •

edited

Loading

dongsam Aug 9, 2023

zsystm Aug 9, 2023 •

edited

Loading

dongsam Aug 9, 2023

zsystm Aug 10, 2023 •

edited

Loading

zsystm Aug 10, 2023

dongsam Aug 10, 2023

zsystm Aug 10, 2023

dongsam Aug 9, 2023

dongsam Aug 9, 2023

zsystm Aug 10, 2023

dongsam Aug 9, 2023

zsystm Aug 10, 2023

dongsam Aug 9, 2023

zsystm Aug 10, 2023

dongsam Aug 9, 2023

dongsam commented Aug 10, 2023

zsystm commented Aug 10, 2023

zsystm commented Aug 10, 2023

dongsam commented Aug 10, 2023

zsystm commented Aug 10, 2023

dongsam left a comment

fix: bugs discovered during simulation #31

fix: bugs discovered during simulation #31

Conversation

zsystm commented Aug 9, 2023 • edited Loading

Description

Author Checklist

Reviewers Checklist

Choose a reason for hiding this comment

zsystm Aug 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zsystm Aug 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dongsam commented Aug 10, 2023

zsystm commented Aug 10, 2023

zsystm commented Aug 10, 2023

dongsam commented Aug 10, 2023

zsystm commented Aug 10, 2023

dongsam left a comment

Choose a reason for hiding this comment

zsystm commented Aug 9, 2023 •

edited

Loading

zsystm Aug 9, 2023 •

edited

Loading

zsystm Aug 10, 2023 •

edited

Loading