blockworks-foundation
/
geyser-grpc-connector
mirror of https://github.com/blockworks-foundation/geyser-grpc-connector.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update Readme wrt filter flexibility

This commit is contained in:
GroovieGermanikus 2023-12-22 17:21:26 +01:00
parent f4fe77167d
commit 5f04447d1e
No known key found for this signature in database
GPG Key ID: 5B6EB831A5CD2015
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -4,8 +4,8 @@
This project provides multiplexing of multiple [Yellowstone gRPC](https://github.com/rpcpool/yellowstone-grpc) subscriptions based on _Fastest Wins Strategy_.
* Multiple _Futures_ get **merged** where the first next block that arrives will be emitted.
* __Reconnects__ are handled transparently inside the _Futures_.
* No __guarantees__ are made about if the messages are continuous or not.
* __Reconnects__ are handled transparently inside the _Futures_.
Disclaimer: The library is designed with the needs of
[LiteRPC](https://github.com/blockworks-foundation/lite-rpc) in mind
@ -19,7 +19,7 @@ Please open an issue if you have any questions or suggestions -> [New Issue](ht
An example how to use the library is provided in `stream_blocks_mainnet.rs`.
## Known issues
* Library does not support other data than Blocks very well.
* Library does not support other data than Blocks/Slots very well.
* Should not be used with commitment level __PROCESSED__ because slot numbers are not monotoic.
* Library needs messages to be in order and provide slot information to work properly.
* The gRPC filtering options are very limited.