[Off-Chain] Add EventsReplayClient Generic Event Listener for BlockClient and DelegationClient

[h5law]

Summary

Human Summary

This PR converts the existing BlockClient into an implenentation of the generic EventsReplayClient which subscribes to and listens for on chain events and maps them into the desired type of the implemented EventsReplayClient

BlockClient -> EventsReplayClient[Block]
DelegationClient -> EventsReplayClient[DelegateeChange]

These new client interfaces have their own methods which wrap those exposed by the EventsReplayClient

AI Summary

Summary generated by Reviewpad on 07 Dec 23 20:34 UTC

This pull request:

• Modifies the ring_signer.go file in the pkg/signer package by updating the comments for the NewRingSigner function and the Sign method.
• Introduces a new client_integration_test.go file in the pkg/client/delegation package, which contains a test function for the DelegationClient redelegation functionality. However, the test is currently skipped and needs further investigation and fixing.
• Adds a new file replay_client.go in the pkg/client/events package, which implements a replay client for handling events and provides various functions for interacting with the client.
• Contains changes in the claim.go file under the pkg/relayer/session package, involving refactoring and optimization of code.
• Removes an empty line in the SupplierAll function in a certain file.
• Deletes the errors.go file, which contained a package named websocket and imported another package named errorsmod, as well as defined an error variable and a codespace variable.
• Adds a new file godoc.go in the pkg/client/block package, which is a wrapper for the EventsReplayClient[Block] generic and listens for committed block events on the chain.
• Introduces a new file event.proto in the pocket/application directory, defining a protocol buffer message EventRedelegation for application delegatee gateway changes on the chain.
• Includes changes in a certain file related to table formatting, addition of new interfaces and components, and import statements.
• Adds a new file errors.go with error handling functionality specific to event handling in the client package.
• Modifies the flag descriptions and import statements in a certain file.
• Changes import statements and the file structure in a certain file.
• Updates comments, including changes from "serialised" to "serialized" in various files.
• Adds a new file client_test.go with test cases for the DelegationClient struct.
• Introduces a new file websocket that provides a websocket client for connecting to a cosmos-sdk based chain node.
• Adds a new file godoc.go that contains documentation for the delegation package and its functionalities.
• Adds a new file redelegation.go that defines a struct and a factory function for deserializing data into the struct.
• Adds a new file that provides a generic client for subscribing to on-chain events with the usage of ReplayObservables.
• Renames and modifies import statements in a file.
• Modifies a file by adding assertions for events in test functions.
• Renames and modifies the client_integration_test.go file, including changes in the package name and import statements.
• Modifies a file by adding new lines, formatting, and emission of events.
• Deletes the events_query.md file that provided an overview of the package.
• Changes the URL in the Makefile for accessing the generated documentation.
• Modifies the import statement in a file.
• Adds a new method to a struct in a file.

Please let me know if you need further assistance or have any questions.

Issue

• Fixes N/A

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 go_develop_and_test
• 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]

@h5law Skipping this over for now but please request a review when we should take look.

[bryanchriswhite]

I finally got through it! 😅🎉

This PR is in great shape, especially for its size. I have one more round of comments and then I think it'll be good to go.

I also wanted to call out #220 (comment) and #220 (comment) to make sure that we don't loose track of them.

[h5law]

@Olshansk @bryanchriswhite Should be good to go now <3

[bryanchriswhite]

Preemptively approving but I have one last change request regarding the sequence diagram.

Thanks for all your patience! 🙈

All comments addressed, discussed offline