feat(x/ecocredit): add buy/sell expiration #671

ryanchristo · 2021-12-15T16:45:17Z

Description

Closes: #636

Add expiration to buy and sell orders and remove expired buy and sell orders with BeginBlocker.

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

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 the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
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)

codecov · 2021-12-15T17:06:10Z

Codecov Report

Merging #671 (54776f9) into master (3ff0a1c) will increase coverage by 0.21%.
The diff coverage is 89.55%.

❗ Current head 54776f9 differs from pull request most recent head 071c3bc. Consider uploading reports for the commit 071c3bc to get more accurate results

@@            Coverage Diff             @@
##           master     #671      +/-   ##
==========================================
+ Coverage   75.88%   76.10%   +0.21%     
==========================================
  Files         113      115       +2     
  Lines       18568    18834     +266     
==========================================
+ Hits        14090    14333     +243     
- Misses       3574     3587      +13     
- Partials      904      914      +10

Flag	Coverage Δ
experimental-codecov	`76.21% <89.55%> (+0.21%)`	⬆️
stable-codecov	`68.93% <89.55%> (+0.36%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

ryanchristo · 2021-12-17T21:22:33Z

pending #647

ryanchristo · 2022-01-13T18:18:35Z

app/app.go

@@ -406,7 +406,7 @@ func NewRegenApp(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest
 	// NOTE: capability module's beginblocker must come before any modules using capabilities (e.g. IBC)
 	app.mm.SetOrderBeginBlockers(
 		upgradetypes.ModuleName, capabilitytypes.ModuleName, minttypes.ModuleName, distrtypes.ModuleName, slashingtypes.ModuleName,
-		evidencetypes.ModuleName, stakingtypes.ModuleName, ibchost.ModuleName,
+		evidencetypes.ModuleName, stakingtypes.ModuleName, ibchost.ModuleName, /* ecocredit.ModuleName, */


Any ideas why adding this would cause the tests to hang?

It times out after 10 minutes with the following error:

tx.go:102: Error Trace: tx.go:102 suite.go:118 tx.go:50 modules_test.go:12 Error: Received unexpected error: rpc error: code = NotFound desc = rpc error: code = NotFound desc = account regen1huayfhrzpkxxws60dxlzv6p3l6e95nau7yk3as not found: key not found Test: TestEcocreditIntegration panic: test timed out after 10m0s

i'm wondering if this has anything to do with the ecocredit module not fulfilling the interface that actually contains the BeginBlock signature.

might need to : add this to the ecocredit/module/module.go file var _ module.AppModule = Module{} and implement the methods it says its missing. maybe that would work?

I think it might be best to break this out into a separate issue. The ecocredit module does not implement the AppModule interface and in attempting to do so there are some conflicts with the RegisterServices method which uses a different Configurator. Opened #689.

technicallyty · 2022-01-13T23:10:09Z

app/app.go

@@ -406,7 +406,7 @@ func NewRegenApp(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest
 	// NOTE: capability module's beginblocker must come before any modules using capabilities (e.g. IBC)
 	app.mm.SetOrderBeginBlockers(
 		upgradetypes.ModuleName, capabilitytypes.ModuleName, minttypes.ModuleName, distrtypes.ModuleName, slashingtypes.ModuleName,
-		evidencetypes.ModuleName, stakingtypes.ModuleName, ibchost.ModuleName,
+		evidencetypes.ModuleName, stakingtypes.ModuleName, ibchost.ModuleName, /* ecocredit.ModuleName, */


is ecocredit commented out due to errors?

correct, not sure how to resolve at the moment: #671 (comment)

let's leave it for a next task.

x/ecocredit/client/testsuite/query.go

x/ecocredit/expected_keepers.go

x/ecocredit/module/module.go

x/ecocredit/abci.go

x/ecocredit/msgs.go

proto/regen/ecocredit/v1alpha2/events.proto

robert-zaremba · 2022-01-14T19:34:23Z

proto/regen/ecocredit/v1alpha2/events.proto

+
+  // new_expiration is the optional timestamp when the sell order expires. When the
+  // expiration time is reached, the sell order is removed from state.
+  google.protobuf.Timestamp new_expiration = 7 [ (gogoproto.stdtime) = true ];


do we really want to use new_ prefix?

We are using new_quantity and new_ask_price so new_expiration made sense.

yeah, we don't do that in general. The other parts were not yet released. Let's chat about naming in the discord or standup.

x/ecocredit/abci.go

x/ecocredit/client/tx.go

x/ecocredit/expected_keepers.go

robert-zaremba · 2022-01-14T19:58:30Z

x/ecocredit/msgs.go

 			return err
 		}

-		if !m.Orders[i].AskPrice.Amount.IsPositive() {
+		if !order.AskPrice.Amount.IsPositive() {


IMHO, ValidateBasic should be minimalistic. All other validation should go in other function: cosmos/cosmos-sdk#10680

It looks like this is still in discussion. Maybe we can address this in all modules and all implementations of validate basic at a later point in time once there is an agreed upon solution?

I think the stricter version is fine for now and that was more or less the outcome of the github discussion

x/ecocredit/msgs.go

x/ecocredit/server/expiration.go

robert-zaremba · 2022-01-14T20:10:21Z

x/ecocredit/server/expiration.go

+	}
+
+	var sellOrders []*ecocredit.SellOrder
+	_, err = orm.ReadAll(sellOrdersIter, &sellOrders)


we only need to read the id, not the whole object.

True but I'm not sure we have a way to only read the id. As far as I can see, we have to load the whole object here but maybe I'm missing something?

Switched to LoadNext to consolidate within the loop as suggested but still loading the whole object. Let me know if I'm missing something that would allow reading the id only.

LoadNext returns RowID. I think this is the ID you are looking for. So we can save empty bytes as the value.

Correct but LoadNext still loads the whole object. We have to pass a proto message as the destination. RowID returns the id in bytes, which we can convert, but we already have the id from the loaded object.

robert-zaremba · 2022-01-20T01:19:45Z

x/ecocredit/server/server.go

+	}, uint64(0))
+	if err != nil {
+		panic(err.Error())
+	}


Other way to avoid the round trip with de-serialization of index, would be to add a delete method to the index (we can make a task for that). CC: @aaronc

context: #671 (comment)

x/ecocredit/server/msg_server.go

robert-zaremba

I've updated the time parsing flow and organized the tests - they are more readable (and shorter).

x/ecocredit/client/tx.go

technicallyty

👍🏻

robert-zaremba

thanks for the work! we can handle the issue with the index removal roundtrip in a separate task.

x/ecocredit/client/tx.go

ryanchristo changed the title ~~Ryan/636 buy sell expiration~~ feat(x/ecocredit): add buy/sell expiration Dec 15, 2021

ryanchristo added the Scope: x/ecocredit Issues that update the x/ecocredit module label Dec 17, 2021

Base automatically changed from aleem/646-ecocredit-projects to master January 3, 2022 17:20

feat(x/ecocredit): add buy/sell expiration

8a1bfd2

ryanchristo force-pushed the ryan/636-buy-sell-expiration branch from 7d25b66 to 8a1bfd2 Compare January 3, 2022 17:56

ryanchristo and others added 6 commits January 3, 2022 10:25

feat(x/ecocredit): add buy/sell expiration

29b561a

feat(x/ecocredit): add buy/sell expiration

e0e40ec

prune orders unit tests v1

59e5c97

update expiration test

0d578f7

Merge branch 'master' into ryan/636-buy-sell-expiration

6b97ceb

fix expiration index

3b602ac

ryanchristo commented Jan 13, 2022

View reviewed changes

ryanchristo marked this pull request as ready for review January 13, 2022 18:20

ryanchristo requested review from technicallyty, aleem1314 and robert-zaremba January 13, 2022 18:20

technicallyty reviewed Jan 14, 2022

View reviewed changes

robert-zaremba reviewed Jan 14, 2022

View reviewed changes

address review comments

9fa1b45

amaury1093 assigned blushi Jan 17, 2022

ryanchristo added 2 commits January 18, 2022 13:58

address review comment

bbfd904

Merge branch 'master' into ryan/636-buy-sell-expiration

4a04cba

ryanchristo mentioned this pull request Jan 19, 2022

Add ecocredit module to module manager #689

Closed

4 tasks

robert-zaremba reviewed Jan 20, 2022

View reviewed changes

Merge branch 'master' into ryan/636-buy-sell-expiration

3781a67

ryanchristo requested review from robert-zaremba and technicallyty January 20, 2022 21:31

technicallyty reviewed Jan 21, 2022

View reviewed changes

x/ecocredit/server/msg_server.go Show resolved Hide resolved

ryanchristo requested a review from technicallyty January 21, 2022 05:30

robert-zaremba added 2 commits January 21, 2022 20:42

adding parseAndSetDate

7d18334

organize tests

239923f

robert-zaremba reviewed Jan 21, 2022

View reviewed changes

x/ecocredit/client/tx.go Show resolved Hide resolved

technicallyty approved these changes Jan 22, 2022

View reviewed changes

ryanchristo added 2 commits January 24, 2022 10:27

address review comments

8cf6281

Merge branch 'master' into ryan/636-buy-sell-expiration

54776f9

ryanchristo requested a review from robert-zaremba January 24, 2022 18:29

robert-zaremba approved these changes Jan 25, 2022

View reviewed changes

x/ecocredit/client/tx.go Outdated Show resolved Hide resolved

x/ecocredit/client/tx.go Outdated Show resolved Hide resolved

ryanchristo added 2 commits January 25, 2022 09:07

cleanup

c29ab33

Merge branch 'master' into ryan/636-buy-sell-expiration

f67cde6

ryanchristo enabled auto-merge (squash) January 25, 2022 17:09

Merge branch 'master' into ryan/636-buy-sell-expiration

071c3bc

ryanchristo merged commit 26cb432 into master Jan 25, 2022

ryanchristo deleted the ryan/636-buy-sell-expiration branch January 25, 2022 17:13

ryanchristo mentioned this pull request Jan 25, 2022

feat: ecocredit ORM proto definitions #700

Merged

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(x/ecocredit): add buy/sell expiration #671

feat(x/ecocredit): add buy/sell expiration #671

ryanchristo commented Dec 15, 2021 •

edited by zube bot

Loading

codecov bot commented Dec 15, 2021 •

edited

Loading

ryanchristo commented Dec 17, 2021 •

edited

Loading

ryanchristo Jan 13, 2022

ryanchristo Jan 13, 2022

technicallyty Jan 14, 2022 •

edited

Loading

ryanchristo Jan 19, 2022

technicallyty Jan 13, 2022

ryanchristo Jan 14, 2022

robert-zaremba Jan 20, 2022

robert-zaremba Jan 14, 2022

ryanchristo Jan 14, 2022

robert-zaremba Jan 19, 2022

robert-zaremba Jan 14, 2022

ryanchristo Jan 14, 2022

robert-zaremba Jan 19, 2022

aaronc Jan 25, 2022

robert-zaremba Jan 14, 2022

ryanchristo Jan 18, 2022

ryanchristo Jan 18, 2022

robert-zaremba Jan 20, 2022

ryanchristo Jan 20, 2022

robert-zaremba Jan 20, 2022

robert-zaremba left a comment

technicallyty left a comment

robert-zaremba left a comment

feat(x/ecocredit): add buy/sell expiration #671

feat(x/ecocredit): add buy/sell expiration #671

Conversation

ryanchristo commented Dec 15, 2021 • edited by zube bot Loading

Description

Author Checklist

Reviewers Checklist

codecov bot commented Dec 15, 2021 • edited Loading

Codecov Report

ryanchristo commented Dec 17, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

technicallyty Jan 14, 2022 • 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

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

robert-zaremba left a comment

Choose a reason for hiding this comment

technicallyty left a comment

Choose a reason for hiding this comment

robert-zaremba left a comment

Choose a reason for hiding this comment

ryanchristo commented Dec 15, 2021 •

edited by zube bot

Loading

codecov bot commented Dec 15, 2021 •

edited

Loading

ryanchristo commented Dec 17, 2021 •

edited

Loading

technicallyty Jan 14, 2022 •

edited

Loading