Jepsen/mdbook

[0xJepsen]

I added some more to the documentation here

• Events
• Subscriptions

contributes to #2282

[prestwich]

High-level changes:

It would be good to route users to the abigen!-based interfaces for accessing these tools, as they're simpler and higher level. This documentation is a good explanation of how abigen works under the hood

We should also mention the difference between Event::stream and Event::subscribe. the stream interface is polling, and will work with any provider, but have increased cost and latency. Subscribe is based on WS/IPC notifications, and is limited to those providers

[0xJepsen]

Thanks for the feedback, I went and made some of the easy changes. I have yet to distinguish the difference between Event::stream and Event::subscribe like you recommended but will look to getting around to it soon.

[prestwich]

Thanks for the feedback, I went and made some of the easy changes. I have yet to distinguish the difference between Event::stream and Event::subscribe like you recommended but will look to getting around to it soon.

did you intend to do this as part of this PR? or in a future one?

[prestwich]

Since this is at risk of getting stale, I'm going to re-run CI and merge if succesful. Followup work can be a separate PR

[prestwich]

CI failures unrelated