{"id":28633571,"url":"https://github.com/trueblocks/trueblocks-khedra","last_synced_at":"2025-06-12T15:09:05.511Z","repository":{"id":270356497,"uuid":"910088046","full_name":"TrueBlocks/trueblocks-khedra","owner":"TrueBlocks","description":"A multi-service EVM blockchain index/monitoring tool that indexes, monitors, and shares address appearance indexes.","archived":false,"fork":false,"pushed_at":"2025-05-22T02:21:56.000Z","size":2238,"stargazers_count":3,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-22T02:35:52.681Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TrueBlocks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-30T13:14:39.000Z","updated_at":"2025-05-22T02:21:59.000Z","dependencies_parsed_at":"2024-12-30T15:23:02.737Z","dependency_job_id":"02abd632-a2aa-465c-81e6-1a31f7fad20f","html_url":"https://github.com/TrueBlocks/trueblocks-khedra","commit_stats":null,"previous_names":["trueblocks/trueblocks-khedra"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/TrueBlocks/trueblocks-khedra","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrueBlocks%2Ftrueblocks-khedra","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrueBlocks%2Ftrueblocks-khedra/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrueBlocks%2Ftrueblocks-khedra/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrueBlocks%2Ftrueblocks-khedra/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TrueBlocks","download_url":"https://codeload.github.com/TrueBlocks/trueblocks-khedra/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrueBlocks%2Ftrueblocks-khedra/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259490550,"owners_count":22865769,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-12T15:09:01.914Z","updated_at":"2025-06-12T15:09:05.494Z","avatar_url":"https://github.com/TrueBlocks.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TrueBlocks Khedra\n\n## Intro\n\n`trueblocks-khedra` is an extension (or plugin) to the [TrueBlocks](https://github.com/TrueBlocks/trueblocks-core) system that focuses on providing specialized data extraction, analysis, or other functionality related to Ethereum blockchain indexing. Khedra aims to simplify the process of gathering on-chain data and building advanced, queryable indexes for Ethereum addresses.\n\nKey features:\n\n- **Custom Indexing**: Provides specialized indexing capabilities tailored to specific use-cases beyond the core TrueBlocks functionality.  \n- **Plugin-Based Architecture**: Easily integrates with TrueBlocks while maintaining modular, extensible design.  \n- **Efficient Data Retrieval**: Optimized for quick querying and data lookups, especially when dealing with large Ethereum datasets.\n\n## Installation\n\n### Prerequisites\n\n- Make sure you have [TrueBlocks Core](https://github.com/TrueBlocks/trueblocks-core) installed.  \n- A C++ build environment (such as `g++` or `clang++`) if you plan to compile from source.  \n- [CMake](https://cmake.org/) (version 3.16 or higher recommended).  \n- (Optional) [Docker](https://docs.docker.com/get-docker/) if you plan to run via container.\n\n### Clone this Repository\n\n  ```[bash]\n      git clone https://github.com/TrueBlocks/trueblocks-khedra.git  \n      cd trueblocks-khedra  \n  ```\n\n### Build from Source\n\n  ```[bash]\n      mkdir build \u0026\u0026 cd build  \n      cmake ..  \n      make  \n  ```\n\n   After a successful build, you’ll find the `khedra` executable (or library, depending on how the project is organized) in the build output.\n\n### Install\n\n```[bash]\nsudo make install  \n```\n\n## Configuration\n\nBefore using `khedra`, you may need to configure it to point at the TrueBlocks indexing data or specify custom indexing rules:\n\n- **Config File**: By default, `khedra` may look for a configuration file at `~/.trueblocks/trueblocks-khedra.conf`.  \n- **Environment Variables**:  \n  - `KHEDRA_DATA_DIR`: Path to where you want `khedra` to store or read data.  \n  - `KHEDRA_LOG_LEVEL`: Adjusts the verbosity of logs (`DEBUG`, `INFO`, `WARN`, `ERROR`).\n\nRefer to the sample configuration file (`.conf.example`) in this repo for a template of possible settings.\n\n---\n\n## Docker Version - Building \u0026 Running\n\nBuild the Docker image:\n\n```bash\ndocker build -t trueblocks-khedra .\n```\n\nRun the Docker container (showing the help message by default):\n\n```bash\ndocker run --rm -it trueblocks-khedra\n```\n\nUse a custom command, for example to specify a subcommand or different flags:\n\n```bash\ndocker run --rm -it trueblocks-khedra some-subcommand --flag\n```\n\nAdjust paths, environment variables, or your config file strategy as needed. You can also mount external volumes (e.g., a local ~/.trueblocks directory) if you prefer to maintain data outside the container.\n\n---\n\n## Documentation\n\n\u003c!--\n  BEGIN SECTION: (Exact text from trueblocks-core README)\n  Copy/Paste the \"Documentation\" section here verbatim.\n--\u003e\n\n**(Paste the *exact* Documentation text from the trueblocks-core README here.)**\n\n---\n\n## Linting\n\n\u003c!--\n  BEGIN SECTION: (Exact text from trueblocks-core README)\n  Copy/Paste the \"Linting\" section here verbatim.\n--\u003e\n\n**(Paste the *exact* Linting text from the trueblocks-core README here.)**\n\n---\n\n## Contributing\n\n\u003c!--\n  BEGIN SECTION: (Exact text from trueblocks-core README)\n  Copy/Paste the \"Contributing\" section here verbatim.\n--\u003e\n\n**(Paste the *exact* Contributing text from the trueblocks-core README here.)**\n\n---\n\n## Contact\n\n\u003c!--\n  BEGIN SECTION: (Exact text from trueblocks-core README)\n  Copy/Paste the \"Contact\" section here verbatim.\n--\u003e\n\n**(Paste the *exact* Contact text from the trueblocks-core README here.)**\n\n---\n\n## Contributors\n\n\u003c!--\n  BEGIN SECTION: (Exact text from trueblocks-core README)\n  Copy/Paste the \"Contributors\" section here verbatim.\n--\u003e\n\n**(Paste the *exact* Contributors text from the trueblocks-core README here.)**\n\n---\n\nThis project is part of the [TrueBlocks](https://github.com/TrueBlocks) ecosystem.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrueblocks%2Ftrueblocks-khedra","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrueblocks%2Ftrueblocks-khedra","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrueblocks%2Ftrueblocks-khedra/lists"}