Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.63 KB

README.md

File metadata and controls

23 lines (16 loc) · 1.63 KB

inx-chronicle

ci Canary Coverage Status

Chronicle is the permanode (sometimes also called indexer or scanner) for the IOTA-based networks. It connects to a Hornet via the IOTA Node Extension (INX) interface. Through the INX interface, Chronicle listens to all blocks in the Tangle that are referenced by a milestone and stores them in a MongoDB database.

Chronicle offers several APIs that are documented here.

Documentation

The documentation for Chronicle can be found in the IOTA wiki: https://wiki.iota.org/chronicle/welcome

Development

This project uses conventional commits to automatically generate a CHANGELOG.md which signals breaking changes. The changelog can be created using the following command (requires the conventional-changelog-cli package on NPM):

conventional-changelog -p conventionalcommits -i CHANGELOG.md -s