v5.0 Readiness Checklist

[ryanchristo]

Summary

This checklist is to be used for tracking the final internal audit of v5.0 changes prior to inclusion in a published release.

Note: One of the goals of this upgrade is to have a stable major version that will allow us to move forward with a series of upgrades that do not introduce API or client breaking changes. We should keep this in mind during the audit process and make sure we are addressing potential API and client breaking changes prior to release.

Release Candidate Checklist

The following checklist should be gone through once the items listed in v5.0 Titicaca Upgrade (#972) have been completed. This audit should be performed directly on main and a release branch should only be created after the audit is complete.

• API audit (at least 1 person)
  • All Msg and Query methods are well-named and organized (@ryanchristo)
  • All types and state objects are well-named and organized (@ryanchristo)
  • All proto comments are up-to-date, informative, and accurate (@technicallyty)
    • docs: update base proto tx docs #1556
    • refactor(x/ecocredit): update credit to basket conversion and docs #1559
    • docs: update marketplace proto  #1560
  • All proto message links are included in module specifications (@aleem1314) docs(x/ecocredit): update client docs #1558
• Unit and integration tests (at least 1 person)
  • ecocredit.v1 unit tests for all messages with emphasis on new messages (@aleem1314 ) test(x/ecocredit): add base v1 sign bytes unit tests #1516
  • ecocredit.v1 unit tests for all queries with emphasis on new queries (@aleem1314 ) refactor(x/ecocredit): remove duplicate pagination nil check #1527
  • ecocredit.basket.v1 unit tests for all messages with emphasis on new messages (@aleem1314 ) test(x/ecocredit): add basket sign bytes unit tests #1528
  • ecocredit.basket.v1 unit tests for all queries with emphasis on new queries (@aleem1314) test(x/ecocredit): add basket sign bytes unit tests #1528
  • ecocredit.marketplace.v1 unit tests for all messages with emphasis on new messages (@aleem1314 )
  • ecocredit.marketplace.v1 unit tests for all queries with emphasis on new queries (@aleem1314 )
• State machine audit (at least 2 people)
  • Make sure state machine logic matches API documentation (@aleem1314 , @technicallyty) refactor(x/ecocredit): remove deprecated params keeper #1543
    • x/ecocredit/base all messages with emphasis on new messages
    • x/ecocredit/basket all messages with emphasis on new messages
    • x/ecocredit/marketplace all messages with emphasis on new messages
  • Read through keeper code and verify correctness upon visual inspection (@aleem1314 , @technicallyty)
    • x/ecocredit/base all messages with emphasis on new messages
    • x/ecocredit/basket all messages with emphasis on new messages
    • x/ecocredit/marketplace all messages with emphasis on new messages
  • Ensure all state machine code which could be confusing is properly commented (@aleem1314 , @technicallyty)
    • x/ecocredit/base all messages with emphasis on new messages
    • x/ecocredit/basket all messages with emphasis on new messages
    • x/ecocredit/marketplace all messages with emphasis on new messages
  • Assess potential threats for each method and ensure that threats have been addressed sufficiently
  • Assess potential risks of any new third party dependencies and decide whether a dependency audit is needed @aleem1314 build: add replace directive for confio/ics23/go #1578
• Completeness audit (at least 1 person)
  • Genesis validation for all state (@aleem1314 )
  • Genesis import and export of all state (@aleem1314 )
  • Query methods for all state (@aleem1314)
  • CLI methods for all messages (@aleem1314)
• Manual testing on a testnet after above items have been addressed (at least 2 people)
  • All Msg methods have been tested (@aleem1314, @ryanchristo, @dpdanpittman)
    • https://hackmd.io/vcNbk99BTiWJ4cMtALSBOA?view
  • All Query methods have been tested (@aleem1314, @ryanchristo, @dpdanpittman)
    • https://hackmd.io/vcNbk99BTiWJ4cMtALSBOA?view
  • Genesis import and export has been tested (@aleem1314, @ryanchristo)
    • https://hackmd.io/vcNbk99BTiWJ4cMtALSBOA?view
    • Validate genesis error: credit batch supply is incorrect #1660
  • IBC and ICA testing (controller, host, fee, etc.) (@aleem1314, @ryanchristo)
    • https://github.com/aleem1314/ica-testing
    • https://hackmd.io/L4Ru-CeuQZ6VMMrBXYDHLA?view
    • https://hackmd.io/xfkQsLDHRVat8nLqtpsbOw?view
  • Amino for gov and group with sdk v0.46.7-regen-1 (@aleem1314)
    • https://github.com/aleem1314/group-gov-amino-testing
    • https://hackmd.io/Q-iN8S0sS-afyRpt8np6Xg
    • amino signing for gov deposit transactions fails #1717
  • Snapshots have been tested with sdk v0.46.7-regen-1 (@ryanchristo)
    • https://hackmd.io/Xspht7-USs-4rMIjffXdMA?view
  • Gov proposal migration works with sdk v0.46.7-regen-2 (@ryanchristo)
    • feat(gov): support v1.Proposal in v1beta1.Proposal.Content cosmos-sdk#51
    • https://hackmd.io/dQLSDStnSMGEnxp-ahXlvg

[aleem1314]

Did manual testing for Amino for group and gov messages. I am able to successfully execute group messages.
I am getting following error for gov messages

"Error when broadcasting tx 194AED34FB434451732E1B3AB869EA42CC004C1631625F3E281CC25A831BC03E at height 0. Code: 4; Raw log: signature verification failed; please verify account number (8), sequence (2) and chain-id (testnet): unauthorized"

Here is the sample repo to test amino signing https://github.com/aleem1314/group-gov-amino-testing

[ryanchristo]

I was able to reproduce the error: https://hackmd.io/Q-iN8S0sS-afyRpt8np6Xg. Looking into it.

[ryanchristo]

Closing as all items have been complete and release process has started.