Update record sanity check #2741

hieuvubk · 2022-09-14T15:28:09Z

Closes: #2686

What is the purpose of the change

Add sanity check in updateRecord to compare record time and height against ctx

Brief Changelog

Created new error type
Add err handle into updateRecord & UpdateRecords
Adjusted test

mattverse

Looks nice! I think we need a test case for checking error on block height and then should be good to merge!

Also curious if the issue / question you asked on the original issue is resolved or if its something that you need further answer on

mattverse · 2022-09-25T09:14:26Z

x/twap/logic_test.go

-					spotPriceA: tPlus10sp5Record.P0LastSpotPrice,
-					spotPriceB: tPlus10sp5Record.P1LastSpotPrice,
-				},
+			expectError: types.InvalidRecordTimeError{


Can we also add a test case for having block height greater than the last record's time and checking the error?

Yes of course

x/twap/types/errors.go

mattverse · 2022-10-11T01:27:43Z

x/twap/logic_test.go

@@ -1234,6 +1253,9 @@ func (s *TestSuite) TestUpdateRecords() {
 			s.SetupTest()
 			twapKeeper := s.App.TwapKeeper
 			ctx := s.Ctx.WithBlockTime(tc.blockTime)
+			if tc.blockHeight != 0 {
+				ctx = s.Ctx.WithBlockHeader(tmproto.Header{Time: tc.blockTime, Height: tc.blockHeight})


Can we use the WithBlockTime and WithBlockHeight API instead?

mattverse · 2022-10-11T01:28:26Z

x/twap/logic_test.go

 		// should always be greater than the last record's time.
-		"two-asset; pre-set at t and t + 1, new record inserted between existing": {
+		"new record can't be inserted before the last record's update time": {


Suggested change

"new record can't be inserted before the last record's update time": {

"new record can't be inserted prior to the last record's update time": {

mattverse · 2022-10-11T01:34:39Z

x/twap/types/errors.go

@@ -62,3 +62,14 @@ type InvalidRecordCountError struct {
 func (e InvalidRecordCountError) Error() string {
 	return fmt.Sprintf("The number of records do not match, expected: %d\n got: %d", e.Expected, e.Actual)
 }
+
+type InvalidRecordTimeError struct {


I'm wondering if we should change this to InvalidUpdateRecordError or something similar, since this error does not only happen when it has a invalid record time but it also includes invlaid record height as well. Lmk what you think

hieuvubk · 2022-10-11T04:56:58Z

nice thank u

…is-labs/osmosis into update_record_sanity_check

mattverse

Nice work, logic lgtm, requesting for additional test cases before we can merge!

mattverse · 2023-04-06T06:41:06Z

x/twap/logic.go

+	// Returns error for last updated records in the same block.
+	// Exception: record is initialized when creating a pool,
+	// then the TwapAccumulator variables are zero.
+	if (record.Height >= ctx.BlockHeight() || !record.Time.Before(ctx.BlockTime())) &&


Suggested change

if (record.Height >= ctx.BlockHeight() || !record.Time.Before(ctx.BlockTime())) &&

if (record.Height > ctx.BlockHeight() || !record.Time.Before(ctx.BlockTime())) &&

Why is it not > but >=? Can the record not have same height as blockheight by design?

Its a case when creating new pool. New twap records will be created and updated immediately. I limit this by adding the condition ArithmeticTwapAccumulator must be zero (init twap record). But I should split it up

sweet, can we add this context as inline comment?

x/twap/logic.go

mattverse

One comment regarding returned error type. Otherwise lgtm

mattverse · 2023-04-10T13:10:33Z

x/twap/logic.go

+	if (record.Height == ctx.BlockHeight() || record.Time.Equal(ctx.BlockTime())) &&
+		!record.P1ArithmeticTwapAccumulator.Equal(sdk.ZeroDec()) &&
+		!record.P0ArithmeticTwapAccumulator.Equal(sdk.ZeroDec()) {
+		return types.TwapRecord{}, fmt.Errorf("Invalid zero twap accumulator")


we should be using return types.TwapRecord{}, types.InvalidUpdateRecordError{ here as well

mattverse · 2023-04-12T00:38:12Z

Sweet! Let's merge this after updating CHANGELOG please @hieuvubk

github-actions · 2023-05-04T00:02:13Z

This pull request has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you!

hieuvubk · 2023-05-05T07:12:00Z

@mattverse hey sr I forgot about this pr :((. Changelog updated

* add new error type * add condition to ensure ctx time > record time * format * replace * fix unused import * update co conditions, bypass the case when creating pool * add cmt * update test for checking block height * format * update err message * update ctx & err * resolve conflict * split condition * update condition & add more test * lint * update return err * update changelog --------- Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>

hieuvubk added 2 commits September 14, 2022 22:23

add new error type

29539a1

add condition to ensure ctx time > record time

7b87cd8

hieuvubk requested a review from a team September 14, 2022 15:28

github-actions bot added the C:x/twap Changes to the twap module label Sep 14, 2022

format

0cbfc04

hieuvubk marked this pull request as draft September 14, 2022 15:37

hieuvubk added 5 commits September 15, 2022 00:06

replace

b09e65f

fix unused import

dfc2307

update co conditions, bypass the case when creating pool

cd78749

add cmt

5e9e64b

resolved conflict

a7b94af

hieuvubk marked this pull request as ready for review September 23, 2022 14:58

mattverse reviewed Sep 25, 2022

View reviewed changes

hieuvubk added 4 commits September 26, 2022 15:16

Merge branch 'main' into update_record_sanity_check

17618aa

update test for checking block height

5c3e98a

format

f7fcdc3

Merge branch 'main' into update_record_sanity_check

c43885d

hieuvubk requested a review from mattverse September 27, 2022 06:25

alexanderbez approved these changes Sep 27, 2022

View reviewed changes

x/twap/types/errors.go Outdated Show resolved Hide resolved

hieuvubk added 2 commits September 28, 2022 01:09

Merge branch 'main' into update_record_sanity_check

acf03e3

update err message

0409367

alexanderbez approved these changes Sep 27, 2022

View reviewed changes

alexanderbez and others added 3 commits September 27, 2022 16:45

Merge branch 'main' into update_record_sanity_check

77502d9

Merge branch 'main' into update_record_sanity_check

fa28336

Merge branch 'main' into update_record_sanity_check

95713c2

mattverse reviewed Oct 11, 2022

View reviewed changes

hieuvubk added 2 commits October 11, 2022 11:59

update ctx & err

24da39c

Merge branch 'update_record_sanity_check' of https://github.com/osmos…

ad6bd30

…is-labs/osmosis into update_record_sanity_check

hieuvubk requested a review from mattverse October 13, 2022 09:52

resolve conflict

bc79f48

hieuvubk added the T:ice-box label Apr 6, 2023

hieuvubk requested a review from p0mvn April 6, 2023 06:28

mattverse reviewed Apr 6, 2023

View reviewed changes

github-actions bot removed the Stale label Apr 7, 2023

hieuvubk added 3 commits April 7, 2023 12:26

split condition

c6f1b8f

update condition & add more test

277d7a7

lint

2f5103d

hieuvubk requested a review from mattverse April 10, 2023 08:13

mattverse added the V:state/breaking State machine breaking PR label Apr 10, 2023

mattverse approved these changes Apr 10, 2023

View reviewed changes

update return err

6574fa6

hieuvubk requested a review from nicolaslara as a code owner April 11, 2023 21:03

mattverse self-assigned this Apr 19, 2023

github-actions bot added the Stale label May 4, 2023

hieuvubk added 2 commits May 5, 2023 14:09

update changelog

a00dbcf

merge main

d9f3a6a

github-actions bot removed the Stale label May 6, 2023

czarcas7ic approved these changes May 6, 2023

View reviewed changes

czarcas7ic merged commit 3608fe9 into main May 6, 2023

czarcas7ic deleted the update_record_sanity_check branch May 6, 2023 01:59

github-actions bot mentioned this pull request Feb 15, 2024

Broken Links Detected #7491

Closed

github-actions bot mentioned this pull request Mar 1, 2024

Broken Links Detected #7641

Closed

github-actions bot mentioned this pull request Mar 15, 2024

Broken Links Detected #7752

Closed

github-actions bot mentioned this pull request May 15, 2024

Broken Links Detected #8269

Closed

github-actions bot mentioned this pull request Oct 15, 2024

Broken Links Detected notional-labs/osmosis#75

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update record sanity check #2741

Update record sanity check #2741

hieuvubk commented Sep 14, 2022

mattverse left a comment

mattverse Sep 25, 2022

hieuvubk Sep 26, 2022

mattverse Oct 11, 2022

mattverse Oct 11, 2022

mattverse Oct 11, 2022

hieuvubk commented Oct 11, 2022

mattverse left a comment

mattverse Apr 6, 2023

hieuvubk Apr 6, 2023

mattverse Apr 10, 2023

mattverse left a comment

mattverse Apr 10, 2023

mattverse commented Apr 12, 2023

github-actions bot commented May 4, 2023

hieuvubk commented May 5, 2023

	"new record can't be inserted before the last record's update time": {
	"new record can't be inserted prior to the last record's update time": {

	if (record.Height >= ctx.BlockHeight() \|\| !record.Time.Before(ctx.BlockTime())) &&
	if (record.Height > ctx.BlockHeight() \|\| !record.Time.Before(ctx.BlockTime())) &&

Update record sanity check #2741

Update record sanity check #2741

Conversation

hieuvubk commented Sep 14, 2022

What is the purpose of the change

Brief Changelog

mattverse left a 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

hieuvubk commented Oct 11, 2022

mattverse left a 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

mattverse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattverse commented Apr 12, 2023

github-actions bot commented May 4, 2023

hieuvubk commented May 5, 2023