Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jurshsmith committed Apr 20, 2024
1 parent 8b738b9 commit 33befa3
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use crate::states::Nft;

pub struct TransferHandler;

#[async_trait::async_trait]
#[chaindexing::augmenting_std::async_trait::async_trait]
impl EventHandler for TransferHandler {
fn abi(&self) -> &'static str {
"event Transfer(address indexed from, address indexed to, uint256 indexed tokenId)"
Expand Down Expand Up @@ -53,28 +53,28 @@ A quick and effective way to get started is by exploring the comprehensive examp

## Design Goals & Features

πŸ’Έ&nbsp;Free forever<br/>
⚑&nbsp;Real-time use-cases<br/>
🌐&nbsp;Multi-chain<br/>
πŸ§‚&nbsp;Granular, 🧩 Modular & πŸ“ˆ Scalable<br/>
🌍&nbsp;Environment-agnostic to allow inspecting πŸ” & replicating indexes anywhere!<br/>
πŸ”“&nbsp;ORM-agnostic, use any ORM to access indexed data<br/>
πŸ“€&nbsp;Easy export to any data lake: S3, Snowflake, etc.<br/>
🚫&nbsp;No complex YAML/JSON/CLI config<br/>
πŸ’ͺ&nbsp;Index contracts discovered at runtime<br/>
✨&nbsp;Handles re-org with no UX impact<br/>
πŸ”₯&nbsp;Side effect handling for notifications & bridging use cases<br/>
πŸ’Έ&nbsp;Optimize RPC cost by indexing when certain activities happen in your DApp<br/>
πŸ’Ž&nbsp;Language-agnostic, so no macros!<br/>
- πŸ’Έ&nbsp;Free forever<br/>
- ⚑&nbsp;Real-time use-cases<br/>
- 🌐&nbsp;Multi-chain<br/>
- πŸ§‚&nbsp;Granular, 🧩 Modular & πŸ“ˆ Scalable<br/>
- 🌍&nbsp;Environment-agnostic to allow inspecting πŸ” & replicating indexes anywhere!<br/>
- πŸ”“&nbsp;ORM-agnostic, use any ORM to access indexed data<br/>
- πŸ“€&nbsp;Easy export to any data lake: S3, Snowflake, etc.<br/>
- 🚫&nbsp;No complex YAML/JSON/CLI config<br/>
- πŸ’ͺ&nbsp;Index contracts discovered at runtime<br/>
- ✨&nbsp;Handles re-org with no UX impact<br/>
- πŸ”₯&nbsp;Side effect handling for notifications & bridging use cases<br/>
- πŸ’Έ&nbsp;Optimize RPC cost by indexing when certain activities happen in your DApp<br/>
- πŸ’Ž&nbsp;Language-agnostic, so no macros!<br/>

## RoadMap

⬜&nbsp;Expose `is_at_block_tail` flag to improve op heuristics for applications<br/>
⬜&nbsp;Support SQLite Database (Currently supports only Postgres)<br/>
⬜&nbsp;Support indexing raw transactions & call traces.<br/>
⬜&nbsp;Improved error handling/messages/reporting (Please feel free to open an issue when an opaque runtime error is encountered)<br/>
⬜&nbsp;SSL Support<br/>
⬜&nbsp;Minimal UI for inspecting events and indexed states<br/>
- ⬜&nbsp;Expose `is_at_block_tail` flag to improve op heuristics for applications<br/>
- ⬜&nbsp;Support SQLite Database (Currently supports only Postgres)<br/>
- ⬜&nbsp;Support indexing raw transactions & call traces.<br/>
- ⬜&nbsp;Improved error handling/messages/reporting (Please feel free to open an issue when an opaque runtime error is encountered)<br/>
- ⬜&nbsp;SSL Support<br/>
- ⬜&nbsp;Minimal UI for inspecting events and indexed states<br/>

## Contributing

Expand Down

0 comments on commit 33befa3

Please sign in to comment.