kadena-io/chainweb-stream

Streaming server for chainweb events

chainweb-stream's Issues

Request for Comments: General

We are prototyping a way of providing near-real-time updates for chain events to alleviate some of the inconvenience of polling chainweb-data and/or chainweb-node repeatedly.

Opening this issue as a place for potential users of this service to offer their thoughts and feedback.

Note that this is still in early development; we thought to reach out early in order to ensure that we will deliver something that fits your use cases as much as possible.

Request for Comments: Is the historical context useful to you? Otherwise the chainweb-data dependency can be dropped.

One of the requirements we set for this project was the ability to provide some historical data for the queries we serve. When you query for an account or a module, you will receive as many historical entries as the ?limit= query parameter you specify*.

This is the reason chainweb-data is a dependency. Since we need that "path" to read historical data, we also use it for all data reads instead of chainweb-node. If builders/users have their own historical data sources or do not need this feature, then removing the chainweb-data dependency and switching to reading from chainweb-node will simplify both the chainweb-stream implementation and its deployment / maintenance.

* The exception is a bug I just found regarding the very first "instance" of query you make: if cw-stream does not have that account/module/event data cached, you will receive the past 100 transactions regardless of ?limit. I will look into this.