{"id":19291839,"url":"https://github.com/hirosystems/runehook","last_synced_at":"2025-04-22T06:31:48.053Z","repository":{"id":246785905,"uuid":"798406971","full_name":"hirosystems/runehook","owner":"hirosystems","description":"Bitcoin Runes indexer and Runes API","archived":true,"fork":false,"pushed_at":"2025-03-14T13:39:56.000Z","size":483,"stargazers_count":11,"open_issues_count":0,"forks_count":5,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2025-04-15T21:43:54.785Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://api.hiro.so/runes","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hirosystems.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","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}},"created_at":"2024-05-09T18:00:10.000Z","updated_at":"2025-03-14T14:01:48.000Z","dependencies_parsed_at":"2024-07-29T20:39:30.935Z","dependency_job_id":"661c6933-eec9-4781-8cd3-1995ad51f3ea","html_url":"https://github.com/hirosystems/runehook","commit_stats":null,"previous_names":["hirosystems/runehook"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hirosystems%2Frunehook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hirosystems%2Frunehook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hirosystems%2Frunehook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hirosystems%2Frunehook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hirosystems","download_url":"https://codeload.github.com/hirosystems/runehook/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250183245,"owners_count":21388682,"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":"2024-11-09T22:28:05.981Z","updated_at":"2025-04-22T06:31:48.047Z","avatar_url":"https://github.com/hirosystems.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e [!IMPORTANT]\n\u003e This repository is now deprecated. For Runes indexing and Runes API, please refer to our new [Bitcoin Indexer](https://github.com/hirosystems/bitcoin-indexer) repository.\n\n       /     /   ▶ Runehook   \n      / --- /      Runes indexing service and REST API based on Chainhook\n     /     /       \n\n* [Features](#features)\n* [Quick Start](#quick-start)\n    * [System Requirements](#system-requirements)\n    * [Indexing Runes](#indexing-runes)\n* [Bugs and Feature Requests](#bugs-and-feature-requests)\n* [Contribute](#contribute)\n* [Community](#community)\n\n***\n\n# Features\n\n* Runes indexing\n    * Etchings, mints, transfers, burns\n    * Account balance tracking\n    * Rune chainhook predicates (coming soon!)\n* REST API endpoints\n    * Rune etching and supply information\n    * Rune activity per block, transaction, account\n    * Balances and holders\n\n# Quick Start\n\nFor instructions to run the REST API or endpoint reference, take a look at the [API README](./api/README.md).\n\n## System Requirements\n\nTo run runehook, you will need:\n\n1. A fully synchronized Bitcoin node.\n1. A local writeable Postgres database for data storage.\n   * We recommended a 1TB volume size.\n\n## Getting started\n\n1. Clone the repo and install runehook\n    ```\n    cargo runehook-install\n    ```\n\n1. Generate a new config file. Make sure to fill in the correct information.\n    ```\n    runehook config new\n    ```\n\n1. Start the indexing service\n    ```\n    runehook service start --config-path Runehook.toml\n    ```\n\n# Bugs and feature requests\n\nIf you encounter a bug or have a feature request, we encourage you to follow the\nsteps below:\n\n 1. **Search for existing issues:** Before submitting a new issue, please search\n    [existing and closed issues](../../issues) to check if a similar problem or\n    feature request has already been reported.\n 1. **Open a new issue:** If it hasn't been addressed, please [open a new\n    issue](../../issues/new/choose). Choose the appropriate issue template and\n    provide as much detail as possible, including steps to reproduce the bug or\n    a clear description of the requested feature.\n 1. **Evaluation SLA:** Our team reads and evaluates all the issues and pull\n    requests. We are avaliable Monday to Friday and we make a best effort to\n    respond within 7 business days.\n\nPlease **do not** use the issue tracker for personal support requests or to ask\nfor the status of a transaction. You'll find help at the [#support Discord\nchannel](https://discord.gg/SK3DxdsP).\n\n\n# Contribute\n\nDevelopment of this product happens in the open on GitHub, and we are grateful\nto the community for contributing bugfixes and improvements. Read below to learn\nhow you can take part in improving the product.\n\n## Code of Conduct\nPlease read our [Code of conduct](../../../.github/blob/main/CODE_OF_CONDUCT.md)\nsince we expect project participants to adhere to it. \n\n## Contributing Guide\nRead our [contributing guide](.github/CONTRIBUTING.md) to learn about our\ndevelopment process, how to propose bugfixes and improvements, and how to build\nand test your changes.\n\n# Community\n\nJoin our community and stay connected with the latest updates and discussions:\n\n- [Join our Discord community chat](https://discord.gg/ZQR6cyZC) to engage with\n  other users, ask questions, and participate in discussions.\n\n- [Visit hiro.so](https://www.hiro.so/) for updates and subcribing to the\n  mailing list.\n\n- Follow [Hiro on Twitter.](https://twitter.com/hirosystems)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhirosystems%2Frunehook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhirosystems%2Frunehook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhirosystems%2Frunehook/lists"}