[Application] Implement MsgStakeApplication & Add Extensive Tests

[Olshansk]

Summary

Screen.Recording.2023-10-16.at.5.11.57.PM.mov

Human Summary

• Add stake to the Application type
• Add stake to the StakeApplication command
• Implement unit tests in all related parts of the codebase (CLI, genesis, keeper, etc...) with the exception of the simulation package
• Small helpers (e.g. Makefile)

Auto-Generated Summary

Summary generated by Reviewpad on 18 Oct 23 14:36 UTC

This pull request includes the following changes:

1. In the file README.md, the project name has been changed from "pocket" to "poktroll". The project description has also been updated to reflect the use of Rollkit, Cosmos SDK, and CometBFT for the Shannon upgrade of the Pocket Network blockchain. The sections "Getting Started" and "Release" have been added, while the sections "Configure", "Web Frontend", and "Learn more" have been removed. The "Install" section has been updated with instructions for installing the latest version of the blockchain node's binary.

2. A new file tx_stake_application_test.go has been added in the cli package of the x/application module. This file contains test cases for the stake application CLI command. The tests cover various scenarios, such as staking with valid inputs, missing address, invalid address, missing stake, invalid stake denom, and invalid stake amount.

3. In a file, a new import statement for the package github.com/cometbft/cometbft-db has been added. Additionally, some import statements have been updated and commented. A function initSDKConfig() has been changed to InitSDKConfig().

4. In the file go.mod, some changes have been made to the "require" section. New modules have been added, and one module has been removed. The google.golang.org/genproto module has been updated.

5. The file config.yml has undergone changes. The names of some accounts in the accounts section have been modified. The genesis section has been updated with additional information and comments.

6. Changes have been made to the file application.go. An import statement for github.com/cosmos/cosmos-sdk/types has been added, and the types package from pocket/x/application has been imported.

7. A new mock for the BankKeeper has been added in a file. The file also includes modifications to the ApplicationKeeper to use this mock.

8. The file errors.go has been updated with changes to import statements and the addition of new error variables.

9. The file genesis_test.go has been modified with changes to import statements, comments, and the TestGenesis function.

10. The file MessageStakeApplication in the types package has been updated with changes to import statements and the addition of a new field.

11. The .gitignore file has undergone changes, including the addition of patterns to ignore specific file extensions.

12. Modifications have been made to the Makefile, including changes to variables, the addition of new commands, and reordering of existing commands.

13. The openapi.yml file has been changed with additions to the application object in multiple places.

14. The file genesis.go has been updated with changes to import statements and the addition of validation logic.

15. The file app.go has been modified with changes to import statements, the introduction of a constant, and the addition of a comment.

16. The file mocks.go has been added, providing documentation on dynamically generated structs.

17. The file tx_stake_application.go has been modified with changes to import statements, command descriptions, and the addition of logic to parse and validate the stake amount.

18. The file keeper_test.go has been added, containing test cases for the MsgServer_StakeApplication function in the keeper package.

19. The file genesis_test.go has been modified with changes to import statements and the addition of test cases for the validation of the GenesisState struct.

20. The file sample_test.go has been added, containing test cases for validating the ApplicationList field in the GenesisState struct.

21. The file .github/workflows/go.yml has undergone changes, involving reordering of steps and modifications to the "Test" step.

This pull request includes various updates and additions to the project documentation, test files, import statements, command functionalities, and workflow configurations.

Issue

Part of #8

Type of change

Select one or more:

• New feature, functionality or library
• Bug fix
• Code health or cleanup
• Documentation
• Other (specify)

Testing

• Run all unit tests: make test_all_unit
• Verify Localnet manually: See the instructions [here](TODO: add link to instructions)

Sanity Checklist

• I have tested my changes using the available tooling
• I have performed a self-review of my own code
• I have commented my code, updated documentation and left TODOs throughout the codebase

[bryanchriswhite]

If this is only being exposed for testing purposes, wdyt about adding a test_config.go file which exposes a wrapper and has a //go:build test tag/constraint?:

//go:build test

package cmd

// InitSDKConfig exports initAppConfig for use in tests
func InitSDKConfig() {
	initSDKConfig()
}

(see: https://github.com/pokt-network/poktroll/pull/42/files#diff-fe3797aa7d51913c0f4b02574c878cf02042fb8a159d5355a2c1b3731490b982R1)

We would have to update the makefile as well:

.PHONY: go_test
go_test: go_version_check ## Run all go tests
	go test -v -tags test ./...

(see: https://github.com/pokt-network/poktroll/pull/42/files#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52R94-R98)

[Olshansk]

I gave this a shot, but not a fan that new go developers would be confused by the fact that go test ./... doesn't work out of the box. Added a TODO_DISCUSS for now and will revisit after this PR.

[bryanchriswhite]

Previously we had discussed adding //go:build test to all test files to mitigate this concern. The user experience would be that without the -tags test constraint, the go test would say that "no tests were run".

[Olshansk]

I added a TODO link to this discussion. Is it alright if follow up on it outside of this PR?

If we do go with this approach, we should have really good CLI communication to the user to make it obvious how necessary the tag is like YOU HAVE NOT ADDED THIS TAG SO NO TESTS ARE BEING EXECUTED.

[bryanchriswhite]

For sure, we can continue that discussion after this PR.

I'm just now recalling that had also done what you're suggesting 😂. IIRC, there was a test which did not have the test build constraint and would check whether the -tags flag contained test, and return a similar error if not. I'll see if I can find it but otherwise, it should be straightforward to reproduce.