[Utility] trustless relay e2e happy case (POC PR)

[adshmh]

Description

[POC] This is a POC PR to add E2E happy case for trsutless relays, described in #754. It is not meant to be merged, but used to:

1. Review the overall approach
2. Define all the required small PRs for making the E2E test pass.

Summary generated by Reviewpad on 30 Jul 23 21:42 UTC

This pull request includes changes across multiple files.

Here is a summary of the changes:

• In the PostV1ClientRelay function, a new field ApplicationAddress is added to the relayMeta struct.
• In the buildJsonRPCRelayPayload function, the field JsonRpc is changed to Jsonrpc for the payload struct. Additionally, the field Id is changed to use a pointer and include the coreTypes.JSONRPCId struct.
• The field Parameters in the body.Payload struct is changed to Params.
• Added import statements: crypto/tls, encoding/json.
• Updated function validateRelayChainSupport: Added a new variable servicerAddrBz and decoded the s.config.Address as a byte array before passing it to readCtx.GetServicer.
• Updated function executeJsonRPCRelay: Changed the way payload is marshalled to JSON using json.Marshal instead of codec.GetCodec().Marshal.
• Updated function executeHTTPRelay: Added a new import statement crypto/tls. Added a new variable tr of type http.Transport with TLSClientConfig set to tls.Config{InsecureSkipVerify: true}. Modified the http.Client initialization to include the new transport configuration.
• In the file shared/core/types/relay.go: In the Validate method of the JSONRPCPayload struct, the p.JsonRpc field has been changed to p.Jsonrpc in the condition and error message. Added a new MarshalJSON method to the JSONRPCId struct to customize the JSON marshalling process.
• In the servicer.go file in the app/client/cli directory: Line 107 - Added applicationAddr as an argument to the buildRelay function call. Line 145 - Added a check for unmarshalling the relay payload using JSON. Line 267 - Added ApplicationAddress to the relayMeta struct.
• In the file rpc/v1/openapi.yaml: Added a comment indicating the need for support for string, number, and NULL values as per the JSONRPC spec. Removed the format: byte property from the id field. Added an items property to the params field, specifying that it should be an array of strings. Added the application_address field to the Payload object, which is of type string.
• In the new file "trustless_relays.feature": Added two scenarios to test the successful response of an application requesting the account balance and the timeout scenario. Also included some comments and TODOs for future improvements and test cases.
• In the Makefile: Added a new target test_e2e_relay, modified the test_all_with_json_coverage target, and updated the TODO_KEYWORDS variable.
• In the relay_test.go file in the shared/core/types package: Added an import statement for the encoding/json package. Changed the field JsonRpc of the JSONRPCPayload struct to Jsonrpc in two test functions. Added a new test function to check the MarshalJSON method of the JSONRPCPayload struct.
• In the file "e2e/tests/steps_init_test.go": Added import statements for "net/http" and "time". Added constant variables and populated maps. Added methods for initialization, sending relays, and checking relay responses. Added a setup function for causing a timeout.
• In the relay.proto file: Added a new message JSONRPCId, changed types, renamed fields, and added comments.
• In the "configs.yaml" file: Modified the "chains" field and the "service_url" field for one entry.
• Added a new file "pocket-servicer-overrides.yaml" with configuration overrides for the Pocket servicer.

Please review these changes carefully and let me know if you need any further assistance.

Issue

Part of work on #754

Type of change

Please mark the relevant option(s):

• [x] New feature, functionality or library
• [x] Bug fix
• [ ] Code health or cleanup
• [x] Major breaking change
• [x] Documentation
• [ ] Other

List of changes

• happy e2e test case for trustless relays
• all proto/openapi changes needed to make the test pass
• all bug fixes needed to make the happy test case pass

Testing

• [ ] make develop_test; if any code changes were made
• [x] make test_e2e on k8s LocalNet; if any code changes were made
• [ ] e2e-devnet-test passes tests on DevNet; if any code was changed
• [ ] Docker Compose LocalNet; if any major functionality was changed or introduced
• [x] k8s LocalNet; if any infrastructure or configuration changes were made

Required Checklist

• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [ ] I have added, or updated, godoc format comments on touched members (see: tip.golang.org/doc/comment)
• [x] I have tested my changes using the available tooling

If Applicable Checklist

• [ ] I have updated the corresponding README(s); local and/or global
• [x] I have added tests that prove my fix is effective or that my feature works
• [ ] I have added, or updated, mermaid.js diagrams in the corresponding README(s)
• [ ] I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

[adshmh]

PRs to be opened to cover all the changes here:

• [ ] PR: add application address and building the relay payload on client side
• [ ] PR: Use pocketk8s to return required keys for application and servicer
• [ ] PR: Update proto type for relay on id and params fields
• [ ] PR: Update openapi spec for id and params fields
• [ ] PR: Fix any bugs in the servicer: e.g. servicer address handling
• [ ] PR: Update e2e feature and step files using the above PRs as base and this PR as template
• [ ] PR: Add a servicer configuration file to LocalNet to list service URLs and settings

[adshmh]

@dylanlott and @Olshansk please note this is a POC only PR and not intended to be merged. I have added the list of PRs that will be opened to make the necessary code changes. The review request here is to make sure the overall approach is reasonable.

[adshmh]

Did a quick initial (partial) review and will do a deeper one on Wednesday

Thank you for the review. I have updated the PR with to address the review comments marked as resolved.

[adshmh]

I think we should update all the RPC ports then to avoid a discrepancy:

Thank you for the review. Will open a separate PR for this shortly.

[Olshansk]

@adshmh When do you think we'll pick up this work again?

[adshmh]

@adshmh When do you think we'll pick up this work again?

Working on it: I will address any remaining ADD_IN_THIS_PR items in a couple of days.