Skip to content

rarible/flow-indexer-public

Repository files navigation

Rarible Protocol Flow Indexer

Spring Boot Application for indexing Flow blockchain, and API for reading NFT.

You can find detailed documentation at docs.rarible.org.

Services

Service Description
backend-api Flow API implementation
scanner Core indexing functionality

For reading NFT events, we need to add Subscriber (see com.rarible.flow.scanner.subscriber package) with the event's description (usually contract name and event name) and start block height.

The service uses Kafka to exchange messages with other Rarible services.

The service also uses MongoDB as a persistence storage.

Important properties

Property Description
blockchain.scanner.flow.chainId Flow network for indexing (MAINNET, TESTNET, EMULATOR)

Use gradle build task to build artifact's.

Suggestions

You are welcome to suggest features and report bugs found!

Contributing

The codebase is maintained using the "contributor workflow" where everyone without exception contributes patch proposals using "pull requests" (PRs). This facilitates social contribution, easy testing, and peer review.

See more information on CONTRIBUTING.md.

License

GPL v3 license is used for all services and other parts of the indexer.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages