[Gateway] Add the Gateway type definition

[h5law]

Summary

Ran ignite scaffold map gateway --module gateway --signer address --no-message --index address --yes

Summary generated by Reviewpad on 12 Oct 23 12:28 UTC

This pull request includes various changes to multiple files. Here is a summary of the diff:

• Changes to the file x/gateway/gateway_test.go:

  • Added test cases to validate the GatewayList field in the GenesisState struct.
  • Assertion added to verify the consistency of the GatewayList in the genesisState and got.GatewayList.

• Changes to the file genesis_test.go:

  • Added new test cases to validate the genesis state for the gateway module.
  • Added gateway addresses in the test cases to ensure proper validation.

• Changes to the file query_gateway_test.go:

  • Added two new test functions to test gateway queries (single and paginated).
  • The functions test various scenarios such as valid requests, key not found, and invalid requests.

• Changes to the file query_gateway.go:

  • Added a new file to the keeper package with two functions: GatewayAll and Gateway.
  • The functions retrieve gateway information based on the provided address and return the response.
  • They handle invalid requests and return appropriate error messages.
  • Dependencies include packages from cosmos-sdk and the query package.

• Changes to the file gateway.go:

  • Added functions for managing gateways in the store (set, get, remove, get all).
  • Included necessary imports and the definition of the Gateway struct.

• Changes to the file gateway.proto:

  • Added a new file defining a protocol buffer message named Gateway with an address field of type string.
  • Located in the proto/pocket/gateway directory and belongs to the pocket.gateway package.
  • Specifies the Go package as pocket/x/gateway/types.

• Changes to the file genesis.go:

  • Added a loop in the InitGenesis function to set gateway elements from the provided genesis state.
  • Modified the ExportGenesis function to set the gatewayList field by calling k.GetAllGateway(ctx).

• Changes to the file gateway_test.go:

  • Added test functions to test the Gateway struct's operations.
  • Includes tests for getting, removing, and getting all gateway items.

• Changes to the file types/key_gateway.go:

  • Added a new file defining the key prefix and key generation function for gateways.

• Changes to the openapi.yml file:

  • Added new API endpoints for retrieving gateway information and querying specific gateways.
  • Added request parameters and response schemas for the new endpoints.

• Changes to the x/gateway/types/genesis.go file:

  • Added import statements and made changes to the GatewayList field initialization.

• Changes to the file x/gateway/client/cli/query_gateway_test.go:

  • Added unit test functions for the CLI query commands related to the gateway module.

• Changes to the file x/gateway/types/genesis.go:

  • Added import statements and made changes to the genesis state initialization.

• Changes to the file query.go:

  • Added new commands for listing and showing gateway information.

These changes aim to enhance various aspects of the gateway module's functionality, including testing, querying, and validation.

Issue

Fixes (in part) 19

[ ] A single PR that defines & updates the Gateway type with required (MVP) fields to support business logic in future work

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

[Olshansk]

You need two PRs:

1. Scaffold the type (see [1] as an example)
2. In a later PR, we add the types (which will require updating a lot of tests)

[1] #48

[Olshansk]

@h5law Another friendly reminder to please update the PR metadata. I did it in this one again.