chore: unify ChainflipIO api interface

[MxmUrw]

Pull Request

Part of PRO-2549

Checklist

Please conduct a thorough self-review before opening the PR.

• I am confident that the code works.
• I have written sufficient tests.
• I have written and tested required migrations.
• I have updated documentation where appropriate.

Summary

This PR unifies how cf methods deal with an expectedEvent argument. The functions that can take such an argument are stepToTransactionIncluded, submitGovernance, submitExtrinsic. They are all implemented in two steps:

1. A helper method called e.g. impl_submitGovernance is implemented. It contains the actual logic. It's return type is Promise<EventFilter>.
2. The actual submitGovernance is automatically derived with the help of cf.wrapWithExpectEvent. This handles the expectedEvent argument and combines it with the event filter returned by the function being wrapped, before passing them to cf.expectEvent.

The visible API change is that now cf.expectEvent takes arg: {event, schema} as argument instead of taking event and schema as two separate arguments.

There's also a change to how the input types of the cf methods are defined, the EventDescription struct now takes a Schema extends z.ZodTypeAny argument. This makes the method declarations a bit easier to read while preserving type inference.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!