Chaindexing

Index any EVM chain and query in SQL

Getting Started | Examples | Design Goals & Features | RoadMap | Contributing

Getting Started

📊 Here is what indexing and tracking owers of your favorite NFTs looks like:

use chaindexing::states::{ContractState, Filters, Updates};
use chaindexing::{EventContext, EventHandler, SideEffectContext, SideEffectHandler};

use crate::states::Nft;

pub struct TransferHandler;

#[async_trait::async_trait]
impl EventHandler for TransferHandler {
    fn abi(&self) -> &'static str {
        "event Transfer(address indexed from, address indexed to, uint256 indexed tokenId)"
    }
    async fn handle_event<'a, 'b>(&self, context: EventContext<'a, 'b>) {
        let event_params = context.get_event_params();

        let _from = event_params.get_address_string("from");
        let to = event_params.get_address_string("to");
        let token_id = event_params.get_u32("tokenId");

        if let Some(existing_nft) =
            Nft::read_one(&Filters::new("token_id", token_id), &context).await
        {
          let updates = Updates::new("owner_address", &to);
          existing_nft.update(&updates, &context).await;
        } else {
            let new_nft = Nft {
                token_id,
                owner_address: to,
            };

            new_nft.create(&context).await;
        }
    }
}

A quick and effective way to get started is by exploring the comprehensive examples provided here: https://github.com/chaindexing/chaindexing-examples/tree/main/rust.

Design Goals & Features

💸 Free forever ⚡ Real-time use-cases 🌐 Multi-chain 🧂 Granular, 🧩 Modular & 📈 Scalable 🌍 Environment-agnostic to allow inspecting 🔍 & replicating indexes anywhere! 🔓 ORM-agnostic, use any ORM to access indexed data 📤 Easy export to your favorite data lake: S3, Snowflake, Redshift 🚫 No complex YAML/JSON/CLI config 💪 Index contracts discovered at runtime ✨ Handles re-org with no UX impact 🔥 Side effect handling for notifications & bridging use cases 💸 Optimize RPC cost by indexing when certain activities happen in your DApp 💎 Language-agnostic, so no macros!

RoadMap

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

Contributing

All contributions are welcome. Before working on a PR, please consider opening an issue detailing the feature/bug. Equally when submitting a PR, ensure that all checks pass to facilitate a smooth review process.