Minimal Baskets/Regen Ledger 3.0

[aaronc]

Guidelines:

• one PR with unit tests per checklist item!
• all PRs against release/v3.0.x unless otherwise noted
• please put your name next to the checkbox item or issue you're tackling and also communicate on discord
• let's keep these small with isolated unit tests so there's a quick turn-around (< 1 day) on each item
• feel free to open multiple PRs for separate items, but review other people's PRs before you start a new one
• to keep momentum, we pass off PRs that we don't have the bandwidth to finish quickly

BLOCKERS

• does MsgCreate ValidateBasic needs fee validation? (only check for valid Coins.Validate() which accepts empty coins)
• add validation & construction for credit class name & basket denom

Todo

• create release/v3.0.x branch
• basic proto files feat(x/ecocredit): add minimal basket proto #731 (against master)
• backport just gogo proto codegen (not api module or .proto files) from feat(x/ecocredit): add minimal basket proto #731 to release/v3.0.x @robert-zaremba
• tag api module on master after feat(x/ecocredit): add minimal basket proto #731 is merged: api/v0.1.0 tagged
• Minimal baskets ORM + keeper setup #735 feat(x/ecocredit): minimal baskets ORM + keeper setup #734 @aaronc
• events.proto on master @ryanchristo feat(x/ecocredit): basket proto events #736
• events.proto release backport (without api module) feat: backport proto generation #743
• query.proto on master + backport (only gogo proto codegen) @technicallyty feat(x/ecocredit): v1 basket query proto #738
• query.proto release backport (without api module) feat: backport proto generation #743
• refactor!: don't use v1 in go package path #740 @robert-zaremba
• add BasketCreationFee param support (is currently breaking tests on release/v3.0x) @aaronc fix(x/ecocredit): broken integration tests from BasketCreationFee param #741
• add rolling date window (based on conversations with @clevinson) @aaronc feat(x/ecocredit)!: support rolling date windows #744
  • tag api package: @aaronc api/v0.2.0 tagged
  • backport feat(x/ecocredit)!: support rolling date windows #744 to release/3.0 @robert-zaremba
  • update ValidateBasic() on MsgCreate to support rolling window -- validate that Duration >= 1 day @robert-zaremba
  • ensure MsgServer implementation supports rolling date window.
• sdk.Msg + sdk.LegacyMsg implementations
  • MsgCreate @robert-zaremba feat(basket): implement sdk.Msg and LegacyMsg for MsgCreate #745
  • MsgPut @technicallyty feat(x/ecocredit): sdk.Msg impl for MsgPut #747
  • MsgTake @ryanchristo feat(x/ecocredit): sdk.Msg for MsgTake #748
• codec registration including amino (with names shorter than 40 characters) @aaronc feat(x/ecocredit): codec and server registration #765
• MsgServer (each of these done with mock-based unit tests initially)
  • Create @robert-zaremba feat(x/ecocredit): Msg Create implementation #762
  • Put @technicallyty feat(x/ecocredit): Put basket server method #758
  • Take @aaronc feat(x/ecocredit): implement basket MsgServer.Take #746
• genesis (should be very simple and use orm ImportJSON/ExportJSON) @aaronc feat(x/ecocredit): basket genesis #764
• queries
  • Basket @ryanchristo feat(x/ecocredit): add Basket query #753
  • Baskets @aaronc feat(x/ecocredit): query baskets #761
  • BasketBalance @aaronc feat(x/ecocredit): add BasketBalance query #751
  • BasketBalances @technicallyty feat(x/ecocredit): QueryBasketBalances #763
• CLI (full integration tests not necessarily needed)
  • tx
    • create-basket @ryanchristo feat(x/ecocredit): add create-basket command #754
    • add-to-basket @aleem1314 feat: add add-to-basket cli command #750
    • take-from-basket @aleem1314 feat: add take-from-basket command #749
  • query
    • basket @technicallyty feat(x/ecocredit): basket query cli cmd #766
    • baskets @technicallyty feat(x/ecocredit): baskets query cli cmd #767
    • basket-balance @aleem1314 feat: add basket balance queries #760
    • basket-balances @aleem1314 feat: add basket balance queries #760

Beta Blocking

• Finalize MsgCreate name, display name and denom validation once we confirm the requirements feat: backport basket proto updates #772 @robert-zaremba
• Upgrade handler (no migrations needed) feat: migration handler for v2.2 #775
  • Confirm default create basket fee - 1000REGEN?
• update proto to remove MsgCreate.prefix and add Basket.name unique index @aaronc feat(x/ecocredit): remove MsgCreate.prefix and add Basket.name #774
• v2.2 update and new api release after feat(x/ecocredit): remove MsgCreate.prefix and add Basket.name #774 @robert-zaremba
• register basket SubModuleName as a module account properly (app.go, etc.) test(x/ecocredit): basket integration test #771
• Set the CoinDenomRegxp (prob also in app.go?) test(x/ecocredit): basket integration test #771

RC Blocking

• Confirm proper event usage (EventRetire, EventReceive, etc.) @aaronc docs(x/ecocredit): clarify EventReceive.sender #778
  • Manually backport to release/v3.0.x and update EventReceive usage @robert-zaremba feat!: basket events update #794
• integration tests added to https://github.com/regen-network/regen-ledger/tree/master/x/ecocredit/server/testsuite @technicallyty test(x/ecocredit): basket integration test #771
• Simulations @aleem1314 feat(x/ecocredit): add basket simulations #769
  • fixing amino signing for date criteria feat: split DateCriteria oneof into separate fields #790 feat: split DateCriteria oneof into separate fields (backport #790) #792
  • properly do Dec -> Int conversion in Put @aaronc feat(types): better tests for math and correct decimal -> integer conversion in x/ecocredit #783
• Fix stable-code-cov: panic on GetParamSet on L34 of x/ecocredit/server/msg_server.go fix(x/ecocredit): InitGenesis and MigrationHandler #784
• add invariant check for ensuring bank supply of basket token equals sum of ecocredits in the basket feat: add basket invariants #787
• ecocredit consensus version should bump to 2 (upgrade handler) feat: handling ecocredits/basket web grpc #789
• register basket related endpoints feat: handling ecocredits/basket web grpc #789

QA

• Testnet creation using export genesis @kaustubhkapatral
  • export mainnet
  • update validator set
  • migrate genesis (existing ecocredit genesis needs to go under regen.ecocredit.v1alpha1.GenesisState key)
• write acceptance tests @ryanchristo docs(x/ecocredit): basket acceptance tests #800
• manually testing (2+ people run this scenario from the CLI) @kaustubhkapatral, @ryanchristo, @clevinson
  • Team audit and @kaustubhkapatral manual testing report: https://hackmd.io/IZittJ8fRoOf-defmaloWQ
  • @ryanchristo manual testing report: https://hackmd.io/wKk_NURPRtyuqcycUdzlnw
  • @clevinson manual testing report: https://hackmd.io/Novv1-fBRvy1O1TQrVVduQ
• code review audit: re-review code committed to release/3.0.x with special emphasis on MsgServer and Msg.ValidateBasic (2 people) @aaronc
  • Locally in IDE run tests with coverage and look for coverage gaps
  • do a diff btw v3.0 and v2.1 tag and read through the diff and write down any issues you see (starting with msgServer code)

---

Nice to Have/Post Release

• Update ecocredit spec with basket functionality #833
• Setup buf push github action on master #779
• Check for key length before accessing a key #834
• add gas Take iteration (state machine breaking - can't be done in point release) @robert-zaremba
• Basket CLI fixes and improvements  #836

[aaronc]

Okay to close this? Should we move the follow-ups to separate issues? Are they getting tracked and addressed?

[ryanchristo]

Okay to close this? Should we move the follow-ups to separate issues? Are they getting tracked and addressed?

Follow-ups added as separate issues and being tracked as part of the v4.0 upgrade. Closing.